a simple example for pict-rs usage

Go to file

Aode (lion) 68d43e0c75 All checks were successful continuous-integration/drone/tag Build is passing Details continuous-integration/drone/push Build is passing Details Update deps		2022-04-07 13:13:08 -05:00
.cargo	Re-enable console	2022-02-26 12:30:03 -06:00
docker	Add console-subscriber, Update rust-runner tag format	2021-12-19 13:19:33 -06:00
images	Images in readme	2020-06-17 18:33:45 -05:00
scss	Add video playback support, fix upload page on small screens	2021-01-05 10:43:48 -06:00
src	Add runtime flag for console	2022-03-23 09:46:30 -05:00
static	favicon	2020-06-17 12:25:57 -05:00
templates	Clippy lints	2021-09-12 11:27:22 -05:00
.drone.yml	Update to latest actix web	2021-12-28 10:55:20 -06:00
.gitignore	Working noscript-compatible pict-rs frontend	2020-06-13 16:23:43 -05:00
Cargo.lock	Update deps	2022-04-07 13:13:08 -05:00
Cargo.toml	Update deps	2022-04-07 13:13:08 -05:00
LICENSE	Working noscript-compatible pict-rs frontend	2020-06-13 16:23:43 -05:00
README.md	Add runtime flag for console	2022-03-23 09:46:30 -05:00

README.md

pict-rs-proxy

a demo frontend for pict-rs supporting noscript

Usage

Running

pict-rs-proxy 0.3.0-rc.3

USAGE:
    pict-rs-proxy [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -a, --addr <addr>
            The address and port the server binds to [env: PICTRS_PROXY_ADDR=]  [default: 0.0.0.0:8081]

        --console-event-buffer-size <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 <domain>
            The scheme, domain, and optional port of the pict-rs proxy server [env: PICTRS_PROXY_DOMAIN=]  [default:
            http://localhost:8081]
    -o, --opentelemetry-url <opentelemetry-url>
            URL of OpenTelemetry Collector [env: PICTRS_PROXY_OPENTELEMETRY_URL=]

    -u, --upstream <upstream>
            The url of the upstream pict-rs server [env: PICTRS_PROXY_UPSTREAM=]  [default: http://localhost:8080]

Examples

Running on all interfaces, port 8081, proxying to localhost:8080

$ ./pict-rs-proxy

Running locally, port 9000, proxying to localhost:4000

$ ./pict-rs-proxy -a 127.0.0.1:9000 -d localhost:4000 -u localhost:4000

Docker production

# Create a folder for the files (anywhere works)
mkdir ./pict-rs-proxy
cd ./pict-rs-proxy
mkdir -p volumes/pictrs
sudo chown -R 991:991 volumes/pictrs
wget https://git.asonix.dog/asonix/pict-rs-proxy/raw/branch/main/docker/prod/docker-compose.yml
sudo docker-compose up -d

Docker development

git clone https://git.asonix.dog/asonix/pict-rs-proxy
cd pict-rs-proxy/docker/dev
docker-compose up --build

Contributing

Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the AGPLv3.

License

pict-rs-proxy is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

pict-rs-proxy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of pict-rs.

You should have received a copy of the GNU General Public License along with pict-rs. If not, see http://www.gnu.org/licenses/.