Installation

So, you want to get started :-) Nothing complicated here, but here is a step by step guide.

Requirements

Once you got the source locally, create a virtualenv and install the dependencies:

python3 -m venv venv
source venv/bin/activate
pip install -e .

Prepare a configuration file, you can copy the config-example.yaml file and edit it:

cp config-example.yaml config.yaml

You can read more about the configuration in the configuration section.

You need to specify environment variables to configure the server, or you can put them in an .env file:

---
caption: .env
---

Then you can start the server:

argos server run

The server will read a yaml file at startup, and will populate the tasks specified in it.

And here is how to run the agent:

argos agent http://localhost:8000 "<auth-token>"

You also need to run cleaning tasks periodically. argos server clean --help will give you more information on how to do that.

Here is a crontab example:

# Run the cleaning tasks every hour (at minute 7)
7 * * * * argos server clean --max-results 100000 --max-lock-seconds 3600