Skip to content

Quick Start

Local Deployment

To deploy Antimony locally, simply use the pre-configured docker compose script in the main repository.

git clone https://github.com/antimony-team/antimony
cd antimony
docker compose up

Docker Desktop

If you are using Docker Desktop on Linux, you might have to explicitly specify the docker host to be set to the dockerd socket.

DOCKER_HOST=unix:///var/run/docker.sock docker compose up

Login

The default login is admin:admin. To change this, change the environment variables SB_NATIVE_USERNAME and SB_NATIVE_PASSWORD in the docker compose file.

docker-compose.yml
environment:
  - SB_NATIVE_USERNAME=admin
  - SB_NATIVE_PASSWORD=admin

Database

By default, Antimony uses a file-based SQLite database. This can be changed by removing the -sqlite=true command line argument in the docker compose file. You can change the database file that Antimony will be using in the config.

config.yml
database:
  localFile: ./db/antimony.db

If instead a PostgreSQL database is used, you can provide the connection details in the configuration file and use an environment variable to set the database password.

config.yml
database:
  host: 127.0.0.1
  port: 5432
  database: antimony
  user: antimony
docker-compose.yml
environment:
  - SB_DATABASE_PASSWORD=password123