orderbooks/config/rclone.example.md
philipp 284e465588
Some checks failed
deploy / deploy (push) Has been cancelled
Prepare Kubernetes orderbooks deployment
2026-04-18 11:23:28 +02:00

1.6 KiB

rclone Configuration Example

Status: valid

This file documents the expected rclone setup for Checkpoint 7. It is not an rclone.conf file and must not be copied into the repository with private auth material.

Remote Name

The examples use this remote path:

gdrive:orderbooks/polymarket

You may choose another remote name or folder. The uploader reads the destination from:

ORDERBOOKS_RCLONE_DEST

For the systemd service, set it in:

/etc/orderbooks/orderbook-uploader.env

Example:

ORDERBOOKS_RCLONE_DEST=gdrive:orderbooks/polymarket

Do not place private auth files, browser tokens, API keys, wallet material, or session material in this repository.

Configure Google Drive Outside The Repo

Install rclone on the VPS, then configure the remote as the service user or with a root-managed config path that the service can read:

sudo apt-get install -y rclone
sudo -u orderbooks rclone config
sudo -u orderbooks rclone lsd gdrive:

If the service user uses the default rclone config path, keep that file outside the repository under the service user's home/config directory.

Uploader Environment File

Create:

/etc/orderbooks/orderbook-uploader.env

Minimal example:

ORDERBOOKS_RCLONE_DEST=gdrive:orderbooks/polymarket

Optional overrides:

ORDERBOOKS_UPLOAD_DATA_DIR=/var/lib/orderbooks
ORDERBOOKS_UPLOAD_MIN_AGE_SECONDS=600
ORDERBOOKS_UPLOAD_RETENTION_DAYS=7
ORDERBOOKS_RCLONE_BIN=/usr/bin/rclone

The environment file belongs on the VPS. Do not commit a machine-local version.