Usage

The just command is used to execute many features for setting up and deploying Voxel Globe. For example, ./just start.

Many commands can be chained together, such as ./just stop start. Some command consume all the remaining arguments thus ending the chain, but these are advanced tools for developers only.

just setting up

command	arguments	usage
install	None	This sets up the initial docker environment and everything necessary to make VoxelGlobe work. See here for more information
sync	None	When updating/changing the version of VoxelGlobe you are using, many of the moving piece may have changes. sync will take care of all the possible pieces that may have changed. See here for more information
start	[service]	This will start a docker running the specific service. The default is to start all
stop	[service]	This will attempt to stop a docker running the specific service. The default is to stop all. This is the safest way to shut down everything, and asks each service to stop. Stop has no timeout, and sometimes will wait forever. See kill
kill	[service]	This will stop all services immediately. There is a small (but unlikely) change of corruption, and so this should not be used until stop fails. Sometimes stop takes forever and you have to call kill to stop the dockers. The default is to kill all
restart	[service]	Stops and restarts a service. The default is to restart all
ps	[service]	Lists all the dockers running or exited. The default is to list all
log	[service]	Shows the logs for services running in VoxelGlobe. The default is to show all logs, and color them on a per service basis
https-submodule	None	Convert the git submodules to use https protocol. Some people can not set up ssh keys for GitHub/Bitbucket, and would rather use https and type in their password. This will change the git repo to use https and prompt you with instructions.
ssh-submodules	None	Same as https-submodule, except switches it back to ssh

Passwords

command	arguments	usage
django-password	None	Interactive program to setup user names and passwords for the Django (the main page) login
reset-passwords	None	Reset the username and passwords to the values set by django-password. The default is vip:vip

Backing up/Restoring

command	arguments	usage
django-dump	None	Dumps the entire database to stdout. You should redirect standard out to a file, i.e. ./just django-dump > mydatabase.json
django-load	filename	Loads the database from the json file created by django-dump.

() - Required

[] - Optional

service - one of the service names, postgresql, rabbitmq, celery, redis, daphne, nginx, uwsgi, asgi, or sometimes notebook and flower

just developing

TODO: Add this