Quick Start
⚠️ Please check the requirements before installing SSM
See Requirements
🔥 Use the Script
- Docker:
shell
curl -sL https://getssm.io | bash
Learn more about Docker install
- Proxmox:
shell
bash -c "$(wget -qLO - https://getssm.io/proxmox)"
Learn more about Proxmox install
Use pre-built Docker images
SSM has published versions of the client and server images according to release tags here. The docker-compose.yml
file uses these pre-built images. To use them, you can set up the following Docker Compose file:
Docker-compose file
yaml
services:
proxy:
restart: unless-stopped
image: "ghcr.io/squirrelcorporation/squirrelserversmanager-proxy:latest"
ports:
- "8000:8000"
depends_on:
- client
- mongo
- server
- redis
mongo:
container_name: mongo-ssm
image: mongo
restart: unless-stopped
volumes:
- ./.data.prod/db:/data/db
command: --quiet
redis:
container_name: cache-ssm
image: redis
restart: unless-stopped
volumes:
- ./.data.prod/cache:/data
command: --save 60 1
server:
image: "ghcr.io/squirrelcorporation/squirrelserversmanager-server:latest"
restart: unless-stopped
healthcheck:
test: curl --fail http://localhost:3000/ping || exit 1
interval: 40s
timeout: 30s
retries: 3
start_period: 60s
external_links:
- mongo
- redis
depends_on:
- mongo
- redis
env_file: .env
environment:
NODE_ENV: production
volumes:
- ./.data.prod/playbooks:/playbooks
- ./.data.prod/config:/ansible-config
client:
image: "ghcr.io/squirrelcorporation/squirrelserversmanager-client:latest"
restart: unless-stopped
depends_on:
- server
.env file
#SECRETS
SECRET=REPLACE_ME
SALT=1234567890123456
VAULT_PWD=REPLACE_ME
#MONGO
DB_HOST=mongo
DB_NAME=ssm
DB_PORT=27017
#REDIS
REDIS_HOST=redis
REDIS_PORT=6379
Replace the values of "SECRET", "SALT", and "VAULT_PWD"
⚠ SALT value MUST be an alphanumeric string of exactly 16 characters
Open a browser and navigate to: http://localhost:8000 or http://127.0.0.1:8000
To update SSM, simply run:
shell
docker-compose pull
docker-compose up
or
shell
docker compose pull
docker compose up
Other install methods:
To manually build the project your self, see this section