Preparation of Environment

1. Node Preparation

The required OS for the VanillaStack is Fedora 32 Server: https://getfedora.org/en/server/download/

The Fedora Server should be installed and updated, before running VanillaStack.

2. Run from source

2.1. Prerequisites

In order to run the VanillaStack Installer from source, you need to have Docker and Node.js installed.

2.2. Clone Repository

Clone the VanillaStack repository at https://github.com/vanillastack/vanillastack and switch to the Backend-branch:

2.2.1. Clone via HTTPS

git clone https://github.com/vanillastack/vanillastack.git

2.2.2. Clone via SSH

git clone git@github.com:vanillastack/vanillastack.git

2.3. Switch to backend-branch

cd vanillastack
git switch backend

2.4. Build Docker Image

Execute the command below:

docker build -f docker/prod/Dockerfile \
  -t vanillastack-installer . && \
  docker run \
  --name vanillastack-installer -d \
  -p 8080:8080 \
  vanillastack-installer
If you want to expose the Docker image, remember to change ports. TIP: You might need to change endpoint.sh file permission in 'vanillastack/backend/docker/prod'

3. Run from Docker-Image

In case you are happy with running a prebuilt Docker image, you can do so.

3.1. Prerequisites

In order to run the VanillaStack Installer Docker image, you need to have Docker installed.

3.2. Download the Image

docker pull harbor.cloudical.net/vanillastack/installer:latest

3.3. Run the Image

docker run \
  --name vanillastack-installer -d \
  -p 8080:8080 \
  harbor.cloudical.net/vanillastack/installer:latest

This exposes the container on port 8080 of your local machine (first parameter after -p) and connects it to port 8080 inside the container.

4. Run VanillaStack Installer

The installer can be found here: http://localhost:8080/

Or any IP/Port you have exposed the Docker container to.

5. API

The API definition can be found with the backend running on:

The definition is written in OpenAPI and can be tested on the spot.