Skip to content

Commit

Permalink
fix(docs): update deployment guide to use new script names for config…
Browse files Browse the repository at this point in the history
…uration and secrets generation (#405)
  • Loading branch information
fassko authored Dec 13, 2024
2 parents c2b4259 + 7423d74 commit a6f4eca
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions docs/fassets/guides/1-deploy-fassets-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Follow these steps to set up the FAssets agent using Docker:
4. Set up the configuration file:

```bash
cp config.json.template config.json
./populate_config.sh
```

5. Login into GitHub Container Registry:
Expand Down Expand Up @@ -119,15 +119,6 @@ Once the database is created, the password will not change if you modify it in t

You can configure several optional settings in the `.env` environment file.

- Choose the profiles of the FAssets agent to run in `COMPOSE_PROFILES`, which by default include the FAssets agent bot, the agent user interface, and the liquidator bot.
- The frontend interface operates on the port designated as `FRONTEND_PORT`, which is set to `3000` by default.
- The link for the agent frontend user interface, referred to as `FRONTEND_URL`, is empty by default.
- The password for the agent frontend user interface is `FRONTEND_PASSWORD`.
- The backend port is `BACKEND_PORT`, which defaults to `4000`.
- The `API_URL` is the default URL of the backend API for the agent user interface.
- The backend URL is `BACKEND_URL`, which defaults to `/fasset-backend`. This change should also be reflected in the `config.json` file for `apiNotifierConfigs.apiUrl`.
- The `ROOT_PATH` is the backend URL.

## Setting up Secret Keys

The FAsset agents require multiple keys for the Flare and underlying network chains, which must be generated to make the agent operational.
Expand All @@ -136,7 +127,7 @@ The FAsset agents require multiple keys for the Flare and underlying network cha
2. Generate the secrets using this command by replacing the `MANAGEMENT_WALLET_ADDRESS` with your management wallet address:

```bash
./generateSecrets.sh MANAGEMENT_WALLET_ADDRESS
./generate_secrets.sh MANAGEMENT_WALLET_ADDRESS
```

3. Copy the `secrets.new.json` to `secrets.json`:
Expand Down

0 comments on commit a6f4eca

Please sign in to comment.