Install Astrolabe

There are two ways to have Astrolabe. Pick one, then configure it.

	SaaS	On-prem
Who runs it	ForgeIT hosts it for you	You run it in your infrastructure
What you receive	An address and an administrator account	The Astrolabe image and the files below
Your data	Hosted by ForgeIT	Stays in your PostgreSQL

☁️ SaaS: we host it for you

1. Ask for your instance on the ForgeIT website: www.forgeit.fr.

2. You receive the address of your Astrolabe and the administrator username and password.

✅ That's it! Go to Configure Astrolabe.

🏢 On-prem: in your infrastructure

You need Docker running on the machine, with 8 GB of memory given to Docker, and the name of the Astrolabe image, which ForgeIT gives you with your license. See Contact us.

1. Create an empty folder and save this file in it as docker-compose.hub.yml.

   name: astrolabe-hub
   
   services:
     postgres:
       image: postgres:14-alpine
       command: postgres -c max_connections=300
       environment:
         POSTGRES_USER: ${POSTGRES_USER:-backstage}
         POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-backstage}
       volumes:
         - astrolabe-postgres:/var/lib/postgresql/data
       healthcheck:
         test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-backstage}"]
         interval: 5s
         timeout: 5s
         retries: 10
   
     astrolabe:
       image: ${ASTROLABE_IMAGE:?set ASTROLABE_IMAGE}
       container_name: astrolabe-hub
       depends_on:
         postgres:
           condition: service_healthy
       ports:
         - "${ASTROLABE_PORT:-7007}:7007"
       environment:
         ENVIRONMENT: production
         FRONTEND_BASE_URL: http://127.0.0.1:${ASTROLABE_PORT:-7007}
         BACKEND_BASE_URL: http://127.0.0.1:${ASTROLABE_PORT:-7007}
         POSTGRES_HOST: postgres
         POSTGRES_PORT: 5432
         POSTGRES_USER: ${POSTGRES_USER:-backstage}
         POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-backstage}
         ADMIN_USERNAME: ${ADMIN_USERNAME:-administrator}
         ADMIN_EMAIL: ${ADMIN_EMAIL:-admin@astrolabe.local}
         ADMIN_PASSWORD: ${ADMIN_PASSWORD:-astrolabe}
         BACKEND_SECRET: ${BACKEND_SECRET:-local-only-change-me-before-sharing}
         ORGANIZATION_NAME: ${ORGANIZATION_NAME:-Astrolabe}
   
   volumes:
     astrolabe-postgres:

2. In a terminal opened in that folder, give the image name and start Astrolabe. Replace the value with the name you received.

   export ASTROLABE_IMAGE=<the image name you received>
   docker compose -f docker-compose.hub.yml up -d

   The first start downloads the image, then prepares the database: allow two to three minutes.

3. Open http://127.0.0.1:7007. Use this address, not localhost: the sign-in compares the address you open with the one in the file.

4. Sign in with the username administrator and the password astrolabe.

5. Before you share this Astrolabe, change the password and the secret. Put them in a .env file next to docker-compose.hub.yml, then start again with the same command as step 2.

   ADMIN_PASSWORD=<a password only you know>
   BACKEND_SECRET=<a long random text>

   tip

   Choose BACKEND_SECRET before you configure anything. It encrypts the secrets you enter in Administration: changing it afterwards makes them unreadable.

✅ That's it! Go to Configure Astrolabe.

To stop Astrolabe, run docker compose -f docker-compose.hub.yml down. Your data stays. To start again, run the command of step 2.

🧪 Try it in one command

To look around before you decide, start a demo on sample data, without PostgreSQL:

docker run --rm -p 7007:7007 --tmpfs /run/astrolabe-db -e DEMO_MODE=true "$ASTROLABE_IMAGE"

Open http://localhost:7007 and sign in with administrator and password. The demo is read-only and everything disappears when you stop the container.

📞 Contact us

• Ask for a demo or an instance: www.forgeit.fr
• Talk to sales: www.forgeit.fr
• Already a customer, you need help: write to support@forgeit.fr.

➡️ Next

Configure Astrolabe: sign in, add your license, connect your tools and fill the catalog.