mirror of
https://github.com/linuxserver/docker-jenkins-builder.git
synced 2026-02-20 02:13:29 +08:00
params added
This commit is contained in:
parent
b8d43b1765
commit
dc1dee77df
@ -72,6 +72,44 @@ services:
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
Parameters are split into two halves with the left hand side representing the host and the right the container side. The colon acts as a separator between them.
|
||||
For example with a port `-p external:internal` - what this shows is the port mapping from the inside to the outside of the container.
|
||||
For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080`
|
||||
http://192.168.x.x:8080 would show you what's running inside the container on port 80.
|
||||
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | --- |
|
||||
| `--net=host | Shares host networking with container. |
|
||||
| `-e PUID=1001` | for UserID - see below for explanation |
|
||||
| `-e PGID=1001` | for GroupID - see below for explanation |
|
||||
| `-e VERSION=latest` | Supported values are LATEST, PLEXPASS or a specific version number. |
|
||||
| `-e TZ=Europe/London` | *Optional* Timezone. |
|
||||
| `-v /config` | Plex metadata location. Budget at 50gb- of disk space for large libraries. An SSD is perferred. |
|
||||
| `-v /data/tv` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. |
|
||||
| `-v /data/movies` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. |
|
||||
| `-v /transcode` | Path for transcoding folder, *optional*. |
|
||||
|
||||
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
|
||||
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Versions
|
||||
|
||||
* **09.12.17:** - Fix continuation lines.
|
||||
|
||||
@ -62,6 +62,39 @@ services:
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
Parameters are split into two halves with the left hand side representing the host and the right the container side. The colon acts as a separator between them.
|
||||
For example with a port `-p external:internal` - what this shows is the port mapping from the inside to the outside of the container.
|
||||
For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080`
|
||||
http://192.168.x.x:8080 would show you what's running inside the container on port 80.
|
||||
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | --- |
|
||||
| `-e PUID=1001` | for UserID - see below for explanation |
|
||||
| `-e PGID=1001` | for GroupID - see below for explanation |
|
||||
| `-v /config` | Configure the `Targets` file here |
|
||||
| `-v /data` | Storage location for db and application data (graphs etc) |
|
||||
|
||||
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
|
||||
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Versions
|
||||
|
||||
* **09.12.17:** - Fix continuation lines.
|
||||
|
||||
@ -110,6 +110,58 @@ services:
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
Parameters are split into two halves with the left hand side representing the host and the right the container side. The colon acts as a separator between them.
|
||||
For example with a port `-p external:internal` - what this shows is the port mapping from the inside to the outside of the container.
|
||||
For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080`
|
||||
http://192.168.x.x:8080 would show you what's running inside the container on port 80.
|
||||
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | --- |
|
||||
{% if param_usage_include_net %}
|
||||
| `--net={{ param_net }} | {{ param_net_desc }} |
|
||||
{% endif %}
|
||||
{% if param_usage_include_ports %}
|
||||
{% for item in param_ports %}
|
||||
| `-p {{ internal_port }}` | {{ port_desc }} |
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if common_param_env_vars_enabled %}
|
||||
{% for item in common_param_env_vars %}
|
||||
| `-e {{ item.env_var }}={{ item.env_value }}` | {{ item.desc }} |
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if param_usage_include_env %}
|
||||
{% for item in param_env_vars %}
|
||||
| `-e {{ item.env_var }}={{ item.env_value }}` | {{ item.desc }} |
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if param_usage_include_vols %}
|
||||
{% for item in param_volumes %}
|
||||
| `-v {{ item.vol_path }}` | {{ item.desc }} |
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
|
||||
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Versions
|
||||
|
||||
{% for item in changelogs %}
|
||||
|
||||
@ -11,24 +11,25 @@ common_param_env_vars_enabled: true #PGID, PUID, etc
|
||||
param_container_name: "{{ project_name }}"
|
||||
param_usage_include_net: true
|
||||
param_net: "host"
|
||||
param_net_desc: "Shares host networking with container."
|
||||
param_usage_include_env: true
|
||||
param_env_vars:
|
||||
- { env_var: "VERSION", env_value: "latest" }
|
||||
- { env_var: "TZ", env_value: "Europe/London"}
|
||||
- { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." }
|
||||
- { env_var: "TZ", env_value: "Europe/London", desc: "*Optional* Timezone."}
|
||||
param_usage_include_vols: true
|
||||
param_volumes:
|
||||
- { vol_path: "/config", vol_host_path: "</path/to/plex/library>", desc: "Plex metadata location. Budget at 50gb- of disk space for large libraries. An SSD is perferred." }
|
||||
- { vol_path: "/data/tv", vol_host_path: "</path/to/tvseries>", 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: "Shares host networking with container." }
|
||||
- { 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." }
|
||||
- { vol_path: "/transcode", vol_host_path: "</path/for/transcoding>", desc: "Path for transcoding folder, *optional*." }
|
||||
param_usage_include_ports: false
|
||||
param_ports:
|
||||
- { external_port: "32400", internal_port: "32400" }
|
||||
- { external_port: "32400", internal_port: "32400/udp" }
|
||||
- { external_port: "32469", internal_port: "32400" }
|
||||
- { external_port: "32469", internal_port: "32469/udp" }
|
||||
- { external_port: "5353", internal_port: "5353/udp" }
|
||||
- { external_port: "1900", internal_port: "1900/udp" }
|
||||
- { external_port: "32400", internal_port: "32400", port_desc: "Primary communication port for Plex" }
|
||||
- { external_port: "32400", internal_port: "32400/udp", port_desc: "Primary communication port for Plex" }
|
||||
- { external_port: "32469", internal_port: "32469", port_desc: "DNLA discovery" }
|
||||
- { external_port: "32469", internal_port: "32469/udp", port_desc: "DNLA discovery" }
|
||||
- { external_port: "5353", internal_port: "5353/udp", port_desc: "Bonjour / Avahi discovery" }
|
||||
- { external_port: "1900", internal_port: "1900/udp", port_desc: "DNLA access" }
|
||||
|
||||
optional_block_1: false
|
||||
optional_block_1_items:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user