After installing the necessary elements, we need to create and configure a server.
Servers are created from a configuration file. This file can be generated through the command
vserver newor manually from a YAML file manually, as explained in this section.
After configuring the server, we need to define the users, organizations, collaborations, etc. This can be done using the
vserver import command, as explained in this section.
Notice that we need to follow the same steps when loading/importing new data.
Managing entities at the server (e.g. users, organizations, etc...) is usually done through the RESTful API. As administrator you also have access to a Python API by using the command
vserver shell which opens an iPython shell in which all database models are available. To see what you can do with these models, see this page!
Once the configuration is done and you created at least one user, you can start the server instance by using
vserver start and then selecting the configuration you want to use. If you know the name of the configuration, you can use the flag
--name to specify it. Use
vserver start --help to see all options.
If you have a configuration file which is in a non-default location than you can specify this by the
As a reference, these are the sub-commands available to manage the server(s). These commands can also be found by simply calling
vserver . To see which options are available for each of the individual commands, use
vserver CMD --help.
Attach the logs from the Docker container to the terminal
List the file locations of the server instance
Import server entities as a batch
List the available server instances
Create a new server configuration
Run a server instance python shell
Start the server
Stop a or all running server
Shows the current version of the running server
If you attach the log to the current console, you can see a information about the server. You can either attach the logs when you start the server
vserver start --attach or you can attach to an already running server by using
vserver attach and select the server you want to see the log files from.
For example, the output below shows:
- ---------------------------------------------- Welcome to- _ __- | | / /- __ ____ _ _ __ | |_ __ _ __ _ ___ / /_- \ \ / / _` | '_ \| __/ _` |/ _` |/ _ \ '_ \- \ V / (_| | | | | || (_| | (_| | __/ (_) |- \_/ \__,_|_| |_|\__\__,_|\__, |\___|\___/- __/ |- |___/-- --> Join us on Discord! https://discord.gg/rwRvwyK- --> Docs: https://docs.vantage6.ai- --> Blog: https://vantage6.ai- ---------------------------------------------- Started application vantage6 with environment application- Current working directory is '/'- Succesfully loaded configuration from '/mnt/config/Dave-A.yaml'- Logging to '/mnt/log/dave-a.log'- Common package version '2.1.0'- vantage6 version '2.1.0'- Node package version '2.1.0'- Connecting server: https://trolltunga.vantage6.ai:443
We give some recommendations for deploying a vantage6 server in this section.