🚀Getting Started

The fastest and most efficient way to get started is to run an instance from docker hub. To do that all you need to do is

Ensure docker and docker-compose are installed properly

When you have docker & docker-compose installed you can run the following command to spin up the server.

This method only supports linux/amd64, if you need to build it differently, read how to build using docker.

Below run in command line, it will get the docker-compose file and run docker.

wget https://gist.githubusercontent.com/ywadi/04bfd918715f508fd228cbea55b75f75/raw/3413c99f9d1ecdb88f1541c1d012324a347afb17/docker-compose.yaml ; docker-compose up -d

To change the username and passwords you will need to stop docker $ docker-compose down then modify the docker-compose.yml and change the authentications in environment as needed.

Once the server is up and running you can access the WEB UI from http://localhost:8080/

You can also access the cli tool within the docker container with the following command

docker exec -it crimsonq_crimsonq_1 "crimsonq-cli"

Your server is now up and running. Check out the rest of the documentation on how to use it.

Trying it out on Docker Playground

To give it a run on play with docker you can load and instance by clicking on [HERE]

Once you click the link, click Start and that will create an instance for you to test it out, you can then use the open port button to open the UI on port 8080. After that, you can then SSH into the playground instance and execute the command above to start the CLI.