Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
docs: update configuration docs
Kyle Mendelleaac425fecee
diff --git a/docs/docs/getting-started/configuration.md b/docs/docs/getting-started/configuration.mdindex 507407d91..4a420fd14 100644--- a/docs/docs/getting-started/configuration.md+++ b/docs/docs/getting-started/configuration.md@@ -5,84 +5,29 @@ title: Configuration# Arcane Configuration-Arcane stores all settings securely and lets you manage them easily from the web UI.--## Where Settings Are Stored--- All settings are stored in `/app/data/settings/settings.dat` inside the container All the `sensitive` settings are encrypted.-- While it is possible to edit certain settings from the file directly, IT is recomended to use the Settings UI to configure all settings.--## How to Change Settings+### How to Change Settings1. Open Arcane in your browser-2. Go to **Settings**-3. Change what you need-4. Click **Save**--## Example settings.dat--```json-{- "dockerHost": "unix:///var/run/docker.sock",- "stacksDirectory": "data/stacks",- "autoUpdate": true,- "autoUpdateInterval": 60,- "pollingEnabled": true,- "pollingInterval": 10,- "pruneMode": "dangling",- "maturityThresholdDays": 5,- "onboarding": {- "completed": true,- "completedAt": "2025-05-11T00:25:24.435Z",- "steps": {- "welcome": true,- "password": true,- "settings": true- }- },- "externalServices": {},- "baseServerUrl": "localhost",- "_encrypted": "ENCRYPTED_DATA_STRING"-}-```--## Docker Setup (Quick)--Mount a volume to keep your settings and data:--```yaml-volumes:- - /var/run/docker.sock:/var/run/docker.sock- - arcane-data:/app/data-```--To import stacks, Arcane needs access to your Compose files. Add a bind mount so the path to your Compose files is the same inside and outside the container. (This mount is in addition to the normal `arcane-data` mount)--```yaml-- /host/path/to/stacks:/host/path/to/stacks:ro-```--## Environment Variables--| Variable | Purpose | Default/Example | Notes |-| ------------------------------- | ---------------------------------- | ----------------------------------------------- | ---------------------------- |-| `PUID` | File owner user ID | `1000` | Use your user ID |-| `PGID` | File owner group ID | `1000` | Use your group ID |-| `DOCKER_GID` | Docker group ID | (auto) | Only if needed |-| `APP_ENV` | App environment | `production` | Required for Docker |-| `PUBLIC_SESSION_SECRET` | Session secret | (set this!) | Use a strong value |-| `PUBLIC_ALLOW_INSECURE_COOKIES` | Allow insecure cookies | (unset) | For local HTTP only |-| `PUBLIC_OIDC_ENABLED` | Enable OIDC login | `true` | Sets OIDC Auth to be enabled |-| `OIDC_CLIENT_ID` | Client ID from your OIDC provider | `your_arcane_client_id_from_provider` | NA |-| `OIDC_CLIENT_SECRET` | Client Secret from provider | `your_super_secret_client_secret_from_provider` | NA |-| `OIDC_REDIRECT_URI` | Redirect URI (must match provider) | `http://localhost:3000/auth/oidc/callback` | NA |-| `OIDC_AUTHORIZATION_ENDPOINT` | Auth endpoint URL | `https://your-provider.com/oauth2/authorize` | NA |-| `OIDC_TOKEN_ENDPOINT` | Token endpoint URL | `https://your-provider.com/oauth2/token` | NA |-| `OIDC_USERINFO_ENDPOINT` | Userinfo endpoint URL | `https://your-provider.com/oauth2/userinfo` | NA |-| `OIDC_SCOPES` | Scopes to request | `openid email profile` (default) | NA |-------- Don't touch `settings.dat` directly — all changes should be made in the Arcane UI for safety.-- Back up your `arcane-data` folder regularly to avoid losing settings and stacks.-- Use HTTPS in production to protect your credentials and sessions.+2. Expand the **Settings** section in the sidebar.+3. Choose the section of settings you want to change.+4. Make you changes and Save++### Environment Variables++| Variable | Purpose | Default/Examples | Notes |+| ----------------------------- | --------------------------------------------- | ----------------------------------------------- | ---------------------------- |+| `PORT` | The port arcane should run on | `8080` | Optional |+| `DEV_BACKEND_URL` | The url of the backend for development | `http://localhost:8080` | Development Only |+| `PUID` | File owner user ID | `2000` | Use your user ID |+| `PGID` | File owner group ID | `2000` | Use your group ID |+| `DOCKER_GID` | Docker group ID | (auto) | Only if needed |+| `ENCRYPTION_KEY` | Encrytion Key for secuire stored seitive data | `-` | Required |+| `JWT_SECRET` | Session secret | `-` | Required |+| `OIDC_ENABLED` | Enable OIDC login | `false` | Sets OIDC Auth to be enabled |+| `OIDC_CLIENT_ID` | Client ID from your OIDC provider | `your_arcane_client_id_from_provider` | NA |+| `OIDC_CLIENT_SECRET` | Client Secret from provider | `your_super_secret_client_secret_from_provider` | NA |+| `OIDC_REDIRECT_URI` | Redirect URI (must match provider) | `http://localhost:3000/auth/oidc/callback` | NA |+| `OIDC_AUTHORIZATION_ENDPOINT` | Auth endpoint URL | `https://your-provider.com/oauth2/authorize` | NA |+| `OIDC_TOKEN_ENDPOINT` | Token endpoint URL | `https://your-provider.com/oauth2/token` | NA |+| `OIDC_USERINFO_ENDPOINT` | Userinfo endpoint URL | `https://your-provider.com/oauth2/userinfo` | NA |+| `OIDC_SCOPES` | Scopes to request | `openid email profile` (default) | NA |diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.mdindex 39665211b..25aa4f11e 100644--- a/docs/docs/getting-started/quickstart.md+++ b/docs/docs/getting-started/quickstart.md@@ -7,10 +7,6 @@ title: Quick StartGet Arcane running fast with Docker Compose.-## Prerequisites--- Docker & Docker Compose-## Steps1. **Create `docker-compose.yml`:**@@ -21,20 +17,17 @@ Get Arcane running fast with Docker Compose.image: ghcr.io/ofkm/arcane:latestcontainer_name: arcaneports:- - '3000:3000'+ - '8080:8080'volumes:- /var/run/docker.sock:/var/run/docker.sock- arcane-data:/app/dataenvironment:- - APP_ENV=production # Required- - PUBLIC_SESSION_SECRET=your_super_strong_random_secret_here # Generate: openssl rand -base64 32- # Optional: Match your host user for permissions- - PUID=2000- - PGID=2000- # Optional: Set if Docker access fails- # - DOCKER_GID=998- # Optional: For local HTTP testing only- # - PUBLIC_ALLOW_INSECURE_COOKIES=true+ - PUID=1000+ - PGID=1000+ - DATABASE_URL=sqlite:///app/data/arcane.db+ - ENCRYPTION_KEY=xxxxxxxxxxxxxxxxxxxxxx+ - JWT_SECRET=your-super-secret-jwt-key-change-this-in-production+ - APP_ENV=TESTrestart: unless-stoppedvolumes:@@ -52,15 +45,7 @@ Get Arcane running fast with Docker Compose.```Use `:ro` for read-only access.-3. **Permissions & Environment Variables:**-- - `APP_ENV=production`: Always set for Docker.- - `PUBLIC_SESSION_SECRET`: Must be a secure random string.- - `PUID`/`PGID`: Set to your host user/group IDs to avoid permission issues (`id -u`, `id -g`).- - `DOCKER_GID`: Usually auto-detected. Set only if Arcane can't access Docker (`stat -c '%g' /var/run/docker.sock`).- - `PUBLIC_ALLOW_INSECURE_COOKIES`: Only for local HTTP testing.--4. **Start Arcane:**+3. **Start Arcane:**```bashdocker compose up -d@@ -68,10 +53,5 @@ Get Arcane running fast with Docker Compose._(Use `docker-compose up -d` if needed)_-5. **Access Arcane:**- Go to [http://localhost:3000](http://localhost:3000) in your browser and follow the setup.--## Next Steps--- Manage containers, images, volumes, and networks in the UI.-- See the [Configuration](./configuration.md) guide for more options.+4. **Access Arcane:**+ Go to [http://localhost:8080](http://localhost:8080) in your browser and follow the setup.diff --git a/docs/docs/getting-started/user-management.md b/docs/docs/getting-started/user-management.mdindex eb38c4265..acbc5dfc4 100644--- a/docs/docs/getting-started/user-management.md+++ b/docs/docs/getting-started/user-management.md@@ -38,9 +38,9 @@ OIDC users are auto-provisioned on first login. You can disable local login forYou can also configure OIDC using environment variables:-| Variable | Description | Example/Default |+| Variable | Description | Default/Example || ----------------------------- | ---------------------------------- | ----------------------------------------------- |-| `PUBLIC_OIDC_ENABLED` | Enable OIDC login | `true` |+| `OIDC_ENABLED` | Enable OIDC login | `false` || `OIDC_CLIENT_ID` | Client ID from your OIDC provider | `your_arcane_client_id_from_provider` || `OIDC_CLIENT_SECRET` | Client Secret from provider | `your_super_secret_client_secret_from_provider` || `OIDC_REDIRECT_URI` | Redirect URI (must match provider) | `http://localhost:3000/auth/oidc/callback` |@@ -56,11 +56,8 @@ services:arcane:# ... image, ports, volumes ...environment:- - APP_ENV=production- - PUID=1000- - PGID=1000- - PUBLIC_SESSION_SECRET=your_super_long_random_secret_here- - PUBLIC_OIDC_ENABLED=true+ # ....+ - OIDC_ENABLED=true- OIDC_CLIENT_ID=your_arcane_client_id_from_provider- OIDC_CLIENT_SECRET=your_super_secret_client_secret_from_provider- OIDC_REDIRECT_URI=http://your-arcane-address/auth/oidc/callback