diff --git a/README.lite b/README.lite new file mode 100644 index 0000000..fd0a91b --- /dev/null +++ b/README.lite @@ -0,0 +1,21 @@ +# [linuxserver/snapdrop](https://github.com/linuxserver/docker-snapdrop) + +This readme has been truncated from the full version found [HERE](https://github.com/linuxserver/docker-snapdrop) + +[Snapdrop](https://github.com/RobinLinus/snapdrop) A local file sharing in your browser. Inspired by Apple's Airdrop. + +## Usage + +``` +docker create \ + --name=snapdrop \ + -e PUID=1000 \ + -e PGID=1000 \ + -e TZ=Europe/London \ + -p 80:80 \ + -p 443:443 \ + -v :/config \ + --restart unless-stopped \ + linuxserver/snapdrop +``` + diff --git a/README.md b/README.md index f497151..a4764e4 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ docker create \ -e TZ=Europe/London \ -p 80:80 \ -p 443:443 \ + -v :/config \ --restart unless-stopped \ linuxserver/snapdrop ``` @@ -88,6 +89,8 @@ services: - PUID=1000 - PGID=1000 - TZ=Europe/London + volumes: + - :/config ports: - 80:80 - 443:443 @@ -105,6 +108,7 @@ Container images are configured using parameters passed at runtime (such as thos | `-e PUID=1000` | for UserID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation | | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. | +| `-v /config` | Persistent configs and logs. | ## Environment variables from files (Docker secrets) diff --git a/readme-vars.yml b/readme-vars.yml index 1d47679..0960143 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -30,6 +30,10 @@ param_usage_include_env: true param_env_vars: - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "Persistent configs and logs." } + param_usage_include_ports: true param_ports: - { external_port: "80", internal_port: "80", port_desc: "http gui" }