Get started

Picking a OS

Argon runs on a wide range of operating systems, so pick whichever you are most comfortable using.

Argon does not support most OpenVZ systems due to incompatibilities with Docker. If you are planning on running this software on an OpenVZ based system you will — most likely — not be successful.

Operating System	Version	Supported	Notes
Ubuntu	20.04	✅
	22.04	✅
	24.04	✅	Documentation written assuming Ubuntu 24.04 as the base OS.
RHEL / Rocky Linux / AlmaLinux	8	✅
	9	✅
Debian	11	✅
	12	✅
Windows	10/11	✅	You may have network issues when exposing Argon due to the way Windows' firewall works.
macOS	13+	✅

Dependencies

• Bun 1.2.12 or higher

• curl

• git

Dependency Installation

This is how you'd install Bun on most systems. You can figure out how to install curl. It's pretty much common sense on most systems (:

curl -fsSL https://bun.sh/install | bash

Download Files

The first step in this process is to move into etc. Since the repo is called argon, we'll just rely on git to make the folder.

cd /etc

Now we'll clone the latest version of Argon. (This will be changed to use the latest release in the future rather than the main branch)

git clone https://github.com/argon-foss/argon
cd argon/server

Installation

Package installation

Pretty standard process for a TypeScript/JavaScript app:

bun install
bun link
bun add . # This does something..? We don't really know

Setup

If the argon command can't be found, your system may not support Bun's whatever it is that it does. Use bun run cli in replacement for it where referenced.

Argon's core environment is easily configured using a few CLI commands built into the app.

argon bolt migrate --run # Migrate database
argon bolt info # So we can also give it a chance to do the automatic Units v3 Migration

Seed Units

We probably want some Units to get started with. So we'll seed our units from the official Argon Units repository.

argon unit seed

Add The First User

You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below. At this time passwords must meet the following requirements: 8 characters, mixed case, at least one number.

argon user:create

Run the Application

We're ready to go. Run the following command:

bun run start

Argon will now be available on http://localhost:3000 using static pre-built frontend. If you'd like to run the frontend separately, you can do so by navigating into app , installing modules per usual and using bun run dev there. Make sure to keep both processes running if you do so - the API is served by the main app.