Skip to main content Skip to navigation Skip to footer

Services

Deploy and manage containerized services using Rediaccfiles, service networking, and autostart.

Services

This page covers how to deploy and manage containerized services: Rediaccfiles, service networking, starting/stopping, bulk operations, and autostart.

The Rediaccfile

The Rediaccfile is a Bash script that defines how your services are started and stopped. It is sourced (not executed as a separate process), so its functions share the same shell context and have access to all exported environment variables. It must be named Rediaccfile or rediaccfile (case-insensitive) and placed inside the repository’s mounted filesystem.

Rediaccfiles are discovered in two locations:

  1. The root of the repository mount path
  2. First-level subdirectories of the mount path (not recursive)

Hidden directories (names starting with .) are skipped.

Lifecycle Functions

A Rediaccfile contains up to two functions:

FunctionWhen it runsPurposeError behavior
up()When startingStart services (e.g., renet compose -- up -d)Root failure is critical (stops everything). Subdirectory failures are non-critical (logged, continues)
down()When stoppingStop services (e.g., renet compose -- down)Best-effort — failures are logged but all Rediaccfiles are always attempted

Both functions are optional. If a function is not defined, it is silently skipped.

Execution Order

  • Starting (up): Root Rediaccfile first, then subdirectories in alphabetical order (A to Z).
  • Stopping (down): Subdirectories in reverse alphabetical order (Z to A), then root last.

Environment Variables

When a Rediaccfile function executes, the following environment variables are available:

VariableDescriptionExample
REDIACC_WORKING_DIRMount path of the repository/mnt/rediacc/mounts/abc123
REDIACC_REPOSITORYRepository GUIDa1b2c3d4-e5f6-...
REDIACC_NETWORK_IDNetwork ID (integer)2816
DOCKER_HOSTDocker socket for this repository’s isolated daemonunix:///var/run/rediacc/docker-2816.sock
{SERVICE}_IPLoopback IP for each service defined in .rediacc.jsonPOSTGRES_IP=127.0.11.2

The {SERVICE}_IP variables are auto-generated from the slot mappings in .rediacc.json and exported before your Rediaccfile functions run. The naming convention converts the service name to uppercase with hyphens replaced by underscores, then appends _IP. For example, a service named listmonk-app with slot 0 becomes LISTMONK_APP_IP=127.0.11.2.

Warning: Do not use sudo docker in Rediaccfiles. The sudo command resets environment variables, which means DOCKER_HOST is lost and Docker commands will target the system daemon instead of the repository’s isolated daemon. This breaks container isolation and can cause port conflicts. Rediacc will block execution if it detects sudo docker without -E.

Use renet compose in your Rediaccfiles — it automatically handles DOCKER_HOST, injects networking labels for route discovery, and configures service networking. See Networking for details on how services are exposed via the reverse proxy. If calling Docker directly, use docker without sudo — Rediaccfile functions already run with sufficient privileges. If you must use sudo, use sudo -E docker to preserve environment variables.

renet is the remote low-level tool. For normal user workflows from your workstation, prefer rdc commands such as rdc repo up and rdc repo down. See rdc vs renet.

Example

#!/bin/bash

up() {
    echo "Starting services..."
    renet compose -- up -d
}

down() {
    echo "Stopping services..."
    renet compose -- down
}

Important: Always use renet compose -- instead of docker compose. The renet compose wrapper enforces host networking, IP allocation, and service discovery labels required by renet-proxy. CRIU checkpoint/restore capabilities are added to containers with the rediacc.checkpoint=true label. Direct docker compose usage is rejected by Rediaccfile validation. See Networking for details.

Multi-Service Layout

For projects with multiple independent service groups, use subdirectories:

/mnt/rediacc/repos/my-app/
├── Rediaccfile              # Root: shared setup
├── docker-compose.yml
├── database/
│   ├── Rediaccfile          # Database services
│   └── docker-compose.yml
├── backend/
│   ├── Rediaccfile          # API server
│   └── docker-compose.yml
└── monitoring/
    ├── Rediaccfile          # Prometheus, Grafana, etc.
    └── docker-compose.yml

Execution order for up: root, then backend, database, monitoring (A-Z). Execution order for down: monitoring, database, backend, then root (Z-A).

Service Networking (.rediacc.json)

Each repository gets a /26 subnet (64 IPs) in the 127.x.x.x loopback range. Services bind to unique loopback IPs so they can run on the same ports without conflicts.

The .rediacc.json File

Maps service names to slot numbers. Each slot corresponds to a unique IP address within the repository’s subnet.

{
  "services": {
    "api": {"slot": 0},
    "postgres": {"slot": 1},
    "redis": {"slot": 2}
  }
}

Auto-Generation from Docker Compose

You do not need to create .rediacc.json manually. When you run rdc repo up, Rediacc automatically:

  1. Scans all directories containing a Rediaccfile for compose files (docker-compose.yml, docker-compose.yaml, compose.yml, or compose.yaml)
  2. Extracts service names from the services: section
  3. Assigns the next available slot to new services
  4. Saves the result to {repository}/.rediacc.json

IP Calculation

The IP for a service is calculated from the repository’s network ID and the service’s slot. The network ID is split across the second, third, and fourth octets of a 127.x.y.z loopback address. Services start at offset 2:

OffsetAddressPurpose
.0127.0.11.0Network address (reserved)
.1127.0.11.1Gateway (reserved)
.2 – .62127.0.11.2127.0.11.62Services (slot + 2)
.63127.0.11.63Broadcast (reserved)

Example for network ID 2816 (0x0B00), base address 127.0.11.0:

ServiceSlotIP Address
api0127.0.11.2
postgres1127.0.11.3
redis2127.0.11.4

Each repository supports up to 61 services (slots 0 through 60).

Using Service IPs in Docker Compose

Since each repository runs an isolated Docker daemon, renet compose automatically configures network_mode: host for all services. Bind services to their assigned loopback IPs:

services:
  postgres:
    image: postgres:16
    environment:
      PGDATA: /var/lib/postgresql/data
      POSTGRES_PASSWORD: secret
    command: -c listen_addresses=${POSTGRES_IP} -c port=5432

  api:
    image: my-api:latest
    environment:
      DATABASE_URL: postgresql://postgres:secret@${POSTGRES_IP}:5432/mydb
      LISTEN_ADDR: ${API_IP}:8080

Note: Do not add network_mode: host manually — renet compose injects it automatically. Restart policies (e.g., restart: always) are safe to use — renet auto-strips them for CRIU compatibility and the router watchdog handles container recovery.

Note: Fork repos get flat auto-routes: {service}-{tag}.{machine}.{baseDomain}. Custom domains are skipped for forks.

Starting Services

Mount the repository and start all services:

rdc repo up my-app -m server-1 --mount
OptionDescription
--mountMount the repository first if not already mounted
--skip-router-restartSkip restarting the route server after the operation

The execution sequence is:

  1. Mount the LUKS-encrypted repository (if --mount)
  2. Start the isolated Docker daemon
  3. Auto-generate .rediacc.json from compose files
  4. Run up() in all Rediaccfiles (A-Z order)

Stopping Services

rdc repo down my-app -m server-1
OptionDescription
--unmountUnmount the encrypted repository after stopping. If this does not take effect, use rdc repo unmount separately.
--skip-router-restartSkip restarting the route server after the operation

The execution sequence is:

  1. Run down() in all Rediaccfiles (Z-A reverse order, best-effort)
  2. Stop the isolated Docker daemon (if --unmount)
  3. Unmount and close the LUKS-encrypted volume (if --unmount)

Bulk Operations

Start or stop all repositories on a machine at once:

rdc repo up -m server-1
OptionDescription
--include-forksInclude forked repositories
--mount-onlyOnly mount, don’t start containers
--dry-runShow what would be done
--parallelRun operations in parallel
--concurrency <n>Max concurrent operations (default: 3)
--skip-router-restartSkip restarting the route server after the operation

Autostart on Boot

By default, repositories must be manually mounted and started after a server reboot. Autostart configures repositories to automatically mount, start Docker, and run Rediaccfile up() when the server boots.

How It Works

When you enable autostart for a repository:

  1. A 256-byte random LUKS keyfile is generated and added to the repository’s LUKS slot 1 (slot 0 remains the user passphrase)
  2. The keyfile is stored at {datastore}/.credentials/keys/{guid}.key with 0600 permissions (root-only)
  3. A systemd service (rediacc-autostart) runs at boot to mount all enabled repositories and start their services

On shutdown, the service gracefully stops all services (Rediaccfile down()), stops Docker daemons, and closes LUKS volumes.

Security note: Enabling autostart stores a LUKS keyfile on the server’s disk. Anyone with root access to the server can mount the repository without the passphrase. Evaluate this based on your threat model.

Enable

rdc repo autostart enable my-app -m server-1

You will be prompted for the repository passphrase.

Enable All

rdc repo autostart enable -m server-1

Disable

rdc repo autostart disable my-app -m server-1

This removes the keyfile and kills LUKS slot 1.

Keyfile Refresh on Deploy

When autostart is enabled, rdc repo up validates the LUKS slot 1 keyfile. If the on-disk keyfile still matches the LUKS slot, no changes are made.

After transferring a repository between machines via repo push / repo pull, the keyfile on the new machine won’t match. In this case, repo up automatically regenerates the keyfile and updates LUKS slot 1. You will see log messages:

Refreshing keyfile credential for <guid>
Killing LUKS slot 1: /mnt/rediacc/repositories/<guid>
Adding keyfile to LUKS slot 1: /mnt/rediacc/repositories/<guid>

This is safe — slot 0 (your passphrase) is never modified. If autostart is not enabled, the check is silently skipped. Failures are non-fatal and do not block the deploy.

List Status

rdc repo autostart list -m server-1

Complete Example

This deploys a web application with PostgreSQL, Redis, and an API server.

1. Set Up

curl -fsSL https://www.rediacc.com/install.sh | bash
rdc config init production --ssh-key ~/.ssh/id_ed25519
rdc config machine add prod-1 --ip 203.0.113.50 --user deploy
rdc config machine setup prod-1
rdc repo create webapp -m prod-1 --size 10G

2. Mount and Prepare

rdc repo mount webapp -m prod-1

3. Create Application Files

Inside the repository, create:

docker-compose.yml:

services:
  postgres:
    image: postgres:16
    volumes:
      - ./data/postgres:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: webapp
      POSTGRES_USER: app
      POSTGRES_PASSWORD: changeme
    command: -c listen_addresses=${POSTGRES_IP} -c port=5432

  redis:
    image: redis:7-alpine
    command: redis-server --bind ${REDIS_IP} --port 6379

  api:
    image: myregistry/api:latest
    environment:
      DATABASE_URL: postgresql://app:changeme@${POSTGRES_IP}:5432/webapp
      REDIS_URL: redis://${REDIS_IP}:6379
      LISTEN_ADDR: ${API_IP}:8080

Rediaccfile:

#!/bin/bash

up() {
    mkdir -p data/postgres
    renet compose -- up -d

    echo "Waiting for PostgreSQL..."
    for i in $(seq 1 30); do
        if renet compose -- exec postgres pg_isready -q 2>/dev/null; then
            echo "PostgreSQL is ready."
            return 0
        fi
        sleep 1
    done
    echo "Warning: PostgreSQL did not become ready within 30 seconds."
}

down() {
    renet compose -- down
}

4. Start

rdc repo up webapp -m prod-1

5. Enable Autostart

rdc repo autostart enable webapp -m prod-1