Chewing_Bever
/
otter
1
0
Fork 0
Code Issues 10 Packages Releases 3 Activity
Lightweight implementation of the Gpodder API
104 Commits
2 Branches
3 Tags
956 KiB
Rust 97.6%
HTML 2.4%
 
 
Go to file
Jef Roosens 346c27fc3f
refactor(gpodder): add authenticated view of repository 		2025-06-20 10:43:46 +02:00
bruno
…
docs docs: write small homepage 2025-06-20 10:03:49 +02:00
gpodder refactor(gpodder): add authenticated view of repository 2025-06-20 10:43:46 +02:00
gpodder_sqlite
…
otter refactor(gpodder): add authenticated view of repository 2025-06-20 10:43:46 +02:00
.gitignore
…
.gitmodules chore(docs): set up initial Hugo scaffolding 2025-06-18 12:17:49 +02:00
CHANGELOG.md fix(server): serve Content-Type headers with static files 2025-06-17 15:02:46 +02:00
Cargo.lock fix(server): serve Content-Type headers with static files 2025-06-17 15:02:46 +02:00
Cargo.toml fix(server): serve Content-Type headers with static files 2025-06-17 15:02:46 +02:00
Justfile chore: add docs publish command 2025-06-19 14:53:40 +02:00
README.md
…
otter.toml chore(docs): set up initial Hugo scaffolding 2025-06-18 12:17:49 +02:00

README.md

Otter

Otter is a modern implementation of the Gpodder server API. Its primary goal is to be used as a self-hostable drop-in replacement for Gpodder, suitable for low-power devices.

Features

  • Implementation of API sections needed for synchronization
    • Authentication
    • Devices API
    • Subscriptions API
    • Episode actions API
    • Device synchronization API
  • Easy-to-use server with flexible configuration
    • Can listen on either a TCP or a Unix socket

Configuration

Otter is configurable via a TOML config file, environment variables and CLI arguments thanks to the Figment library. Each variable in the configuration file below can be provided via an environment variable (prefixed using OTTER_) or a CLI argument.

data_dir = "./data"
domain = "127.0.0.1"
port = 8080

Otter can be told to read a config variable using the --config/-c flag (see the help command for other useful CLI commands). Each variable needs to be provided either from the config file, as an environment variable (e.g. OTTER_DATA_DIR) or a CLI argument (e.g. --data-dir).

If a variable is provided in multiple ways, environment variables overwrite configuration file variables, and CLI arguments overwrite both.