Starting Vyne

Learn how to run Vyne

A docker-compose sets up all the services you need.

To get started, simply either clone (using git) or download (using your browser) the Vyne Taxonomy Project on Gitlab.


If you're not familiar with Git, that's fine. Just head over to the Vyne Taxonomy Project on Gitlab, and click to download the source code.

Then, unzip the contents locally.

Docker Compose file

The docker-compose file starts all the vyne components.

To get started, simply open a command prompt in the same directory as you've just donwloaded, and run:

docker-compose up -d

Wait a bit, and then navigate to http://localhost:9022. You should have vyne running, and a simple schema exposed.

Configuring the Schema location

Using the default schema location

By default, this environment will serve the schemas in the ./schemas subdirectory in the folder you're working from.

There's a sample file in there to get you started. You can delete the contents of that directory, and use Visual Studio code to author your own taxonomy files.

Setting your own schema location

If you've got a larger taxi project, you'll likely want to check it out from source control.

Check it out somewhere, then either:

  • Update the TAXONOMY_HOME set in the .env file
  • Or set a TAXONOMY_HOME environment variable:
export TAXONOMY_HOME=/path/to/project
C:> set TAXONOMY_HOME="c:\path\to\project"
PS C:> $env:TAXONOMY_HOME="c:\path\to\project"

The path you specify should either be:

  • A directory containing taxi files
  • A directory containing a taxi.conf file
If you are setting `TAXONOMY_HOME` in the `.env` file, be sure not to place your path inside of quotation marks. However, if you must use quotation marks, be sure to double all your backslashes.