Installation

Install via Docker

Vito provides a single docker image that you can install it easily!

Docker Command

Shell

docker run -v vito_storage:/var/www/html/storage \
    -v vito_plugins:/var/www/html/app/Vito/Plugins \
    -e APP_KEY=your_32_character_app_key  \
    -e NAME=admin_name \
    -e EMAIL=admin_email \
    -e PASSWORD=admin_password \
    -e APP_URL=http://your-vito-url \
    -p 80:80 vitodeploy/vito:latest

APP_KEY is Laravel's encryption key and should be a 32-character string.

Make sure you modify the env variables when running the command.

In order to make sure the app works properly, Make sure you also set the APP_URL environment variable to the URL of your Vito instance.

Some features like Vito Logs works only if you set the APP_URL correctly. Otherwise, it will show you an unauthorized error on the logs page.

Docker Compose

YAML

version: '3'
services:
  vito:
    image: vitodeploy/vito:latest
    ports:
      - '8000:80'
    environment:
      APP_KEY: 'your-32-character-app-key'
      NAME: 'vito'
      EMAIL: '[email protected]'
      PASSWORD: 'password'
      APP_URL: 'http://localhost:8000' # Change this to your Vito URL
    volumes:
      - 'vito-storage:/var/www/html/storage'
      - 'vito-plugins:/var/www/html/app/Vito/Plugins'
volumes:
  vito-storage:
    driver: local
  vito-plugins:
    driver: local

:latest tag is the latest release of VitoDeploy from the 3.x branch, which is stable and recommended for production use.

However, if you would like to use the latest code on the 3.x branch, you may change the image to vitodeploy/vito:3.x.

ARM based images

For arm based architectures, you may add -arm64 to the image name. For example, vitodeploy/vito:3.x-arm64

Environment Variables

APP_KEY: A 32-character string app key used for encryption within the app.

APP_URL: The URL of your Vito instance, by default is http://localhost

NAME: Your account's name

EMAIL: Your account's email for login

PASSWORD: Your account's password for login (You can change it after login)

APP_URL: The URL of your Vito instance, It is required for some features like Vito Logs to work properly.

Install on VPS

Vito can be installed on a fresh Ubuntu server with only one single command.

Requirements

Ubuntu 24.04 LTS Only
1 GB Memory
1 CPU
80 and 443 ports should be open

Other Ubuntu versions have not been tested, and we don't recommend them.

You cannot use Vito to install applications into the same server as Vito. Otherwise, It might crash your Vito instance.

Installation Process

Shell

bash <(curl -Ls https://raw.githubusercontent.com/vitodeploy/vito/3.x/scripts/install.sh)

You need to run the command via root user!

The installation will ask you for these inputs:

Email

This is the admin email that you will use to log into VitoDeploy.

You can also pass this input as an env variable ADMIN_EMAIL

Password

This is the admin user's password.

You can also pass this input as an env variable ADMIN_PASSWORD

Ready

The installation can take several minutes, and after it is done, It will print an output like bellow:

Text

🎉 Congratulations!
✅ SSH User: SSH-USER
✅ SSH Password: SSH-PASSWORD
✅ Admin Email: ADMIN-EMAIL
✅ Admin Password: ADMIN-PASSWORD

At this step, You can ask VitoDeploy by visiting the IP address of your server on a browser.

Make sure that your server is accessible via port 80 and 443.

Now you can attach a domain and secure it.

Install Locally

To contribute to VitoDeploy and run it locally we have Laravel Sail ready!

VitoDeploy is a Laravel project which means you can follow Laravel Documentation to see how you can run it locally but here we will recommend only one way.

VitoDeploy uses OpenSSL keys to connect to your servers so you can manage them, Every Vito instance should have its own public and private key to do so. With the following command, you can generate a key pair.

If you're using Mac or Linux, You can run it on your terminal. If you're using Windows, You can run it on the app container after booting up the app via Laravel Sail.

Shell

openssl genpkey -algorithm RSA -out /PATH_TO_VITO/storage/ssh-private.pem
chmod 600 /PATH_TO_VITO/storage/ssh-private.pem
ssh-keygen -y -f /PATH_TO_VITO/storage/ssh-private.pem > /PATH_TO_VITO/storage/ssh-public.key

Laravel Sail

Sail is not supported for Local Installation anymore. Use Docker instead.

To run the app locally via Laravel Sail clone the repository into your local machine and then run the following commands:

Set the envs

Shell

cp .env.sail .env

Fill the .env file and then

Shell

composer install

And then boot up with Sail

Shell

./vendor/bin/sail up -d

Generate App Key

Shell

./vendor/bin/sail artisan key:generate

Create the database.sqlite in the storage folder.

Run the migrations

Shell

./vendor/bin/sail artisan migrate

Create a new user

Shell

./vendor/bin/sail artisan user:create {name} {email} {password}

Vito by default will run on localhost

. You can change the port on your .env file.

Sail Documentation

Make sure you set these environment variables properly according docker installation.

Introduction Securing