Single Machine / VM

Artemis ships as a set of Docker Compose files managed by the ./artemis CLI (works with both docker compose and podman compose).

Loading latest release…

Review the prerequisites before starting.

1. Supported operating systems

• Any Linux-based distribution, including Red Hat Enterprise Linux 9.0 or later.
• macOS or Windows with a container runtime such as Docker or Podman.

2. Runtime

Install one of:

• Docker
• Podman

3. Latest artifacts

Loading latest release…

Credentials for the file server and image registry are provided separately by TurinTech.

4. Transfer images to an internal registry

Air-gapped and locked-down deployments pull every container image from your own registry instead of from TurinTech's. The transfer.sh helper reads the same Container images list shown under latest artifacts, then copies all required images into the target registry under a turintech/ namespace, so you don't have to enumerate or tag images by hand.

Run it from a host that can reach both the source images and your internal registry (for fully air-gapped sites, this is typically a connected "jump" host or a DMZ mirror):

curl -fsSL https://turintech.github.io/artemis-deployment/transfer.sh | bash -s -- --target myregistry.internal:5000 --type docker

The script verifies access to both registries (prompting you to log in with your TurinTech credentials if needed), prints the full source → target transfer plan for confirmation, then copies each image.

Options

Flag	Description
-t, --target	Target registry, e.g. myregistry.internal:5000 (required)
-T, --type	Image set to transfer: docker or kubernetes (required)
-m, --method	Transfer method: crane (default) or docker
-y, --yes	Skip all confirmation prompts; fails if not already logged in
-h, --help	Show usage

Transfer methods

• crane (default): copies images registry-to-registry without storing them locally, so no large local disk or running Docker daemon is required. crane is downloaded automatically if it isn't already on PATH.
• docker: uses docker pull / tag / push. Requires a running Docker daemon but no extra tooling.

Non-interactive (CI / scripted)

Log in to both registries first, then pass --yes to skip the prompts:

curl -fsSL https://turintech.github.io/artemis-deployment/transfer.sh | bash -s -- --target myregistry.internal:5000 --type docker --method docker --yes

After the transfer

Point the deployment at your registry by setting the following in .env.custom, then run ./artemis deploy:

REGISTRY=myregistry.internal:5000
SERVICES_REGISTRY=myregistry.internal:5000/turintech

5. Installation

Automated (recommended)

Run the installer with the credentials provided by TurinTech. It logs in to the container registry, downloads the deployment package, deploys all services, and creates the default admin user in one step:

curl -fsSL https://turintech.github.io/artemis-deployment/install.sh | bash -s -- --username <file-server-user> --password <file-server-password> --registry-username <registry-user> --registry-password <registry-password>

TurinTech provides all four credentials. --registry-username and --registry-password are optional if Docker is already authenticated with the registry (for example, after a previous docker login). The installer creates an artemis-<version>/ folder in the current directory. When it finishes, Artemis is running and the admin credentials are printed to the terminal.

LLM provider credentials are configured from the Artemis UI after logging in, so no additional deployment configuration is needed for them.

tip

Pass --skip-deploy if you want to review or edit .env.custom before the first deployment:

curl -fsSL https://turintech.github.io/artemis-deployment/install.sh | bash -s -- --username <file-server-user> --password <file-server-password> --registry-username <registry-user> --registry-password <registry-password> --skip-deploy

Then edit artemis-<version>/.env.custom and run ./artemis deploy && ./artemis create-users manually.

Manual

The flow is the same for online and air-gapped deployments. Steps marked Air-gapped only apply when the host has no internet access; skip them otherwise.

1. Provision a VM matching the hardware requirements.

2. Air-gapped only: transfer every image listed under container images into your internal registry. See Transfer images to an internal registry.

3. Authenticate with the image registry:

   • Online: docker login <registry> --username <registry-user> --password <registry-password>
   • Air-gapped: docker login your.internal.registry:5000

4. Download the deployment package and extract it (uses the credentials provided by TurinTech):

   Loading latest release…

   Then move into the extracted folder: cd artemis-….

5. Air-gapped only: edit .env.custom to point at your internal registry (this matches the values printed by the transfer script):

   REGISTRY=your.internal.registry:port
   SERVICES_REGISTRY=your.internal.registry:port/turintech

6. Deploy Artemis:

   ./artemis deploy

7. Create the admin user:

   ./artemis create-users

8. Open Artemis at http://<machine-ip>:80.

note

Run ./artemis info from the deployment folder to view the admin credentials you need to log in.

6. CLI reference

All operations are done with the ./artemis script from inside the deployment folder.

Command	Description
./artemis	List all available commands
./artemis info	Show VM details and admin credentials
./artemis images	List the images used by the deployment
./artemis deploy	Deploy or update all services
./artemis deploy <service>	Deploy a single service
./artemis status	Show health status of all containers
./artemis logs	Follow logs for all services
./artemis logs <service>	Follow logs for a specific service
./artemis restart	Restart all containers
./artemis down	Stop all containers
./artemis destroy	Remove containers and volumes
./artemis update	Check for a new version and update

7. Configuration

All customisation goes into .env.custom in the deployment folder. This file is never overwritten by updates or re-installs, so your changes persist across versions.

warning

Do not edit the base .env file; it is reset on every update. Always use .env.custom.

note

LLM provider credentials are not set here; they are configured from the Artemis UI after logging in.

8. Update

Automated

Run from inside the current deployment folder. The script checks for a newer version, prompts for confirmation, downloads it, and re-deploys your .env.custom and keys/ are carried over automatically:

./artemis update

Manual

1. Download the new deployment package and extract it:

   Loading latest release…

2. Air-gapped: ensure the new container images are in your internal registry. Re-run the transfer script to copy the new release's images across.

3. Move into the new folder and deploy:

   cd artemis-… && ./artemis deploy

4. Open Artemis at http://<machine-ip>:80.

note

Run ./artemis info from the deployment folder to view the admin credentials.

note

Check the release notes for any new environment variables, and add them to .env.custom if needed.