From e8eee973558b41e84bd5403f6e03c9934fdc5b06 Mon Sep 17 00:00:00 2001 From: aptalca Date: Mon, 24 Jun 2019 16:56:13 -0400 Subject: [PATCH] update readme --- README.md | 17 +++++++++-------- readme-vars.yml | 9 +++++---- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 28d027f1..c1b4c10f 100644 --- a/README.md +++ b/README.md @@ -63,10 +63,10 @@ docker create \ -e TZ=Europe/London \ -p 8096:8096 \ -p 8920:8920 `#optional` \ - -v :/config \ - -v :/data/tvshows \ - -v :/data/movies \ - -v :/transcode `#optional` \ + -v /path/to/library:/config \ + -v /path/to/tvshows:/data/tvshows \ + -v /path/to/movies:/data/movies \ + -v /path/for/transcoding:/transcode `#optional` \ --device /dev/dri:/dev/dri `#optional` \ --restart unless-stopped \ linuxserver/emby @@ -89,10 +89,10 @@ services: - PGID=1000 - TZ=Europe/London volumes: - - :/config - - :/data/tvshows - - :/data/movies - - :/transcode #optional + - /path/to/library:/config + - /path/to/tvshows:/data/tvshows + - /path/to/movies:/data/movies + - /path/for/transcoding:/transcode #optional ports: - 8096:8096 - 8920:8920 #optional @@ -214,4 +214,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **24.06.19:** - Fix typos in readme. * **30.05.19:** - Initial release. diff --git a/readme-vars.yml b/readme-vars.yml index df32d12a..7605a97d 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -24,9 +24,9 @@ common_param_env_vars_enabled: true #PGID, PUID, etc param_container_name: "{{ project_name }}" param_usage_include_vols: true param_volumes: - - { vol_path: "/config", vol_host_path: "", desc: "Emby data storage location. *This can grow very large, 50gb+ is likely for a large collection.*" } - - { vol_path: "/data/tvshows", vol_host_path: "", desc: "Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc." } - - { vol_path: "/data/movies", vol_host_path: "", desc: "Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc." } + - { vol_path: "/config", vol_host_path: "/path/to/library", desc: "Emby data storage location. *This can grow very large, 50gb+ is likely for a large collection.*" } + - { vol_path: "/data/tvshows", vol_host_path: "/path/to/tvshows", desc: "Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc." } + - { vol_path: "/data/movies", vol_host_path: "/path/to/movies", desc: "Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc." } param_usage_include_ports: true param_ports: - { external_port: "8096", internal_port: "8096", port_desc: "Http webUI." } @@ -36,7 +36,7 @@ param_env_vars: # optional container parameters opt_param_usage_include_vols: true opt_param_volumes: - - { vol_path: "/transcode", vol_host_path: "", desc: "Path for transcoding folder, *optional*." } + - { vol_path: "/transcode", vol_host_path: "/path/for/transcoding", desc: "Path for transcoding folder, *optional*." } opt_param_device_map: true opt_param_devices: - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "Only needed if you want to use your Intel GPU for hardware accelerated video encoding (vaapi)." } @@ -66,4 +66,5 @@ app_setup_block: | # changelog changelogs: + - { date: "24.06.19:", desc: "Fix typos in readme." } - { date: "30.05.19:", desc: "Initial release." }