diff --git a/README.md b/README.md index 89accd2..964b328 100644 --- a/README.md +++ b/README.md @@ -7,30 +7,26 @@ _a demo frontend for pict-rs supporting noscript_ ## Usage ### Running ``` -pict-rs-proxy 0.3.0-rc.3 +$ pict-rs-proxy -h +A simple web frontend for pict-rs -USAGE: - pict-rs-proxy [OPTIONS] +Usage: pict-rs-proxy [OPTIONS] -FLAGS: - -h, --help Prints help information - -V, --version Prints version information - -OPTIONS: - -a, --addr - The address and port the server binds to [env: PICTRS_PROXY_ADDR=] [default: 0.0.0.0:8081] - - --console-event-buffer-size - Number of events to buffer for the console subscriber. When unset, console will be disabled [env: - PICTRS_PROXY_CONSOLE_BUFFER_SIZE=] - -d, --domain - The scheme, domain, and optional port of the pict-rs proxy server [env: PICTRS_PROXY_DOMAIN=] [default: - http://localhost:8081] - -o, --opentelemetry-url - URL of OpenTelemetry Collector [env: PICTRS_PROXY_OPENTELEMETRY_URL=] - - -u, --upstream - The url of the upstream pict-rs server [env: PICTRS_PROXY_UPSTREAM=] [default: http://localhost:8080] +Options: + -a, --addr + The address and port the server binds to [env: PICTRS_PROXY_ADDR=] [default: 0.0.0.0:8081] + -u, --upstream + The url of the upstream pict-rs server [env: PICTRS_PROXY_UPSTREAM=] [default: http://localhost:8080] + -d, --domain + The scheme, domain, and optional port of the pict-rs proxy server [env: PICTRS_PROXY_DOMAIN=] [default: http://localhost:8081] + --console-event-buffer-size + Number of events to buffer for the console subscriber. When unset, console will be disabled [env: PICTRS_PROXY_CONSOLE_BUFFER_SIZE=] + -o, --opentelemetry-url + URL of OpenTelemetry Collector [env: PICTRS_PROXY_OPENTELEMETRY_URL=] + -h, --help + Print help information + -V, --version + Print version information ``` #### Examples diff --git a/docker/prod/docker-compose.yml b/docker/prod/docker-compose.yml index 331d649..7517d93 100644 --- a/docker/prod/docker-compose.yml +++ b/docker/prod/docker-compose.yml @@ -8,7 +8,7 @@ services: - ./volumes/pictrs:/mnt pictrs-proxy: - image: asonix/pictrs-proxy:v0.3.0-alpha.14 + image: asonix/pictrs-proxy:v0.3.0-beta.1 ports: - "8081:8081" restart: always diff --git a/src/main.rs b/src/main.rs index d02b5b9..ae89d03 100644 --- a/src/main.rs +++ b/src/main.rs @@ -39,7 +39,9 @@ include!(concat!(env!("OUT_DIR"), "/templates.rs")); const HOURS: u32 = 60 * 60; const DAYS: u32 = 24 * HOURS; +/// Simple proxy service to demonstrate pict-rs's functionality #[derive(Clone, Debug, Parser)] +#[command(author, version, about, long_about = None)] struct Config { #[arg( short,