kopia lustrzana https://github.com/linuxserver/docker-documentation
GitBook: [master] 20 pages modified
Josh Stark
gitbook-bot
rodzic
b07039730a
commit
2d06de7e72
|
|
@ -127,6 +127,12 @@ fleet.dockerhub.username=
|
|||
fleet.dockerhub.password=
|
||||
```
|
||||
|
||||
All configuration can be loaded either via the config file, via JVM arguments, or via the system environment. Fleet will first look in the configuration file, then JVM runtime, and finally in the system environment. It will load the first value it finds, which can be useful when needing to override specific properties.
|
||||
|
||||
{% hint style="info" %}
|
||||
If you place a property in the system environment, ensure that the property uses underscores rather than periods. This is due to a limitation in BASH environments where exported variables must not contain this character. E.g. `fleet.app.port=8080` becomes `export fleet_app_port=8080`
|
||||
{% endhint %}
|
||||
|
||||
| Property Name | Purpose |
|
||||
| :--- | :--- |
|
||||
| `fleet.app.port` | The port which the application will be running under. |
|
||||
|
|
|
|||
|
|
@ -1,18 +1,11 @@
|
|||
# [linuxserver/calibre-web](https://github.com/linuxserver/docker-calibre-web)
|
||||
# linuxserver/calibre-web
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/calibre-web "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/calibre-web "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-calibre-web/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/calibre-web/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/calibre-web) [](https://microbadger.com/images/linuxserver/calibre-web)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-calibre-web/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/calibre-web/latest/index.html)
|
||||
|
||||
[Calibre-web](https://github.com/janeczku/calibre-web) is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
|
||||
[Calibre-web](https://github.com/janeczku/calibre-web) is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
|
||||
|
||||
This software is a fork of library and licensed under the GPL v3 License.
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -22,19 +15,18 @@ Simply pulling `linuxserver/calibre-web` should retrieve the correct image for y
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=calibre-web \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -47,7 +39,6 @@ docker create \
|
|||
linuxserver/calibre-web
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -73,41 +64,38 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8083` | WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where calibre-web stores the internal database and config. |
|
||||
| `/books` | Where your calibre database is locate. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -118,12 +106,11 @@ Webui can be found at `http://your-ip:8083`
|
|||
|
||||
On the initial setup screen, enter `/books` as your calibre library location.
|
||||
|
||||
**Default admin login:**
|
||||
*Username:* admin
|
||||
*Password:* admin123
|
||||
**Default admin login:** _Username:_ admin _Password:_ admin123
|
||||
|
||||
To reverse proxy with our Letsencrypt docker container use the following location block:
|
||||
```
|
||||
|
||||
```text
|
||||
location /calibre-web {
|
||||
proxy_pass http://<your-ip>:8083;
|
||||
proxy_set_header Host $http_host;
|
||||
|
|
@ -133,8 +120,6 @@ To reverse proxy with our Letsencrypt docker container use the following locatio
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -153,8 +138,9 @@ To reverse proxy with our Letsencrypt docker container use the following locatio
|
|||
* **03.01.19:** - Remove guest user from default app.db.
|
||||
* **16.08.18:** - Rebase to alpine 3.8.
|
||||
* **03.07.18:** - New build pushed, all versions below `67` have [vulnerability](https://github.com/janeczku/calibre-web/issues/534).
|
||||
* **05.01.18:** - Deprecate cpu_core routine lack of scaling.
|
||||
* **05.01.18:** - Deprecate cpu\_core routine lack of scaling.
|
||||
* **06.12.17:** - Rebase to alpine 3.7.
|
||||
* **27.11.17:** - Use cpu core counting routine to speed up build time.
|
||||
* **24.07.17:** - Curl version for imagemagick.
|
||||
* **17.07.17:** - Initial release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/clarkson](https://github.com/linuxserver/docker-clarkson)
|
||||
# linuxserver/clarkson
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/clarkson "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/clarkson "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-clarkson/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/clarkson/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/clarkson) [](https://microbadger.com/images/linuxserver/clarkson)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-clarkson/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/clarkson/latest/index.html)
|
||||
|
||||
[Clarkson](https://github.com/linuxserver/Clarkson) is a web-based dashboard application that gives you a neat and clean interface for logging your fuel fill-ups for all of your vehicles. The application has full multi-user support, as well as multiple vehicles per user. Whenever you fill-up your car or motorcycle, keep the receipt and record the data in Clarkson.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/clarkson` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=clarkson \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -46,7 +39,6 @@ docker create \
|
|||
linuxserver/clarkson
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -73,43 +65,41 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `3000` | WebUI |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
| Env | Function | |
|
||||
| :---: | :--- | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation | |
|
||||
| `PGID=1000` | for GroupID - see below for explanation | |
|
||||
| `MYSQL_HOST=<mysql_host>` | Points the backend to the MySQL database. This can be either a docker hostname or an IP. | |
|
||||
| `MYSQL_USERNAME=<mysql_username>` | The user with access to the _clarkson_ schema. | |
|
||||
| `MYSQL_PASSWORD=<mysql_password>` | The password for the user. | |
|
||||
| \`ENABLE\_REGISTRATIONS=<true | false>\` | **Defaults to** _**false**_. If set to _true_, allows new users to register. |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | |
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `MYSQL_HOST=<mysql_host>` | Points the backend to the MySQL database. This can be either a docker hostname or an IP. |
|
||||
| `MYSQL_USERNAME=<mysql_username>` | The user with access to the _clarkson_ schema. |
|
||||
| `MYSQL_PASSWORD=<mysql_password>` | The password for the user. |
|
||||
| `ENABLE_REGISTRATIONS=<true|false>` | **Defaults to _false_**. If set to _true_, allows new users to register. |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
|
||||
| :---: | :--- |
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -128,8 +118,6 @@ GRANT ALL ON `clarkson`.* TO 'clarkson_user';
|
|||
|
||||
Once running, the container will run an initial MySQL migration, which populates the schema with all tables and procedures. The application will start immediately afterwards. You will need to register an initial user, of which will be the admin of the application. All subsequent users will be standard users. You can disable registrations after the fact by recreating the container with the `ENABLE_REGISTRATIONS` flag set to `false`. This will not hide the "Register" link, but will disable the functionality.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -147,3 +135,4 @@ Once running, the container will run an initial MySQL migration, which populates
|
|||
* **11.02.19:** - Add pipeline logic and multi arch.
|
||||
* **22.08.18:** - Rebase to alpine linux 3.8.
|
||||
* **19.02.18:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,9 @@
|
|||
# [linuxserver/davos](https://github.com/linuxserver/docker-davos)
|
||||
# linuxserver/davos
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/davos "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/davos "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-davos/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/davos/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/davos) [](https://microbadger.com/images/linuxserver/davos)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-davos/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/davos/latest/index.html)
|
||||
|
||||
[Davos](https://github.com/linuxserver/davos) is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow.
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -20,19 +13,18 @@ Simply pulling `linuxserver/davos` should retrieve the correct image for your ar
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=davos \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -44,7 +36,6 @@ docker create \
|
|||
linuxserver/davos
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -69,40 +60,37 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8080` | This is the default port that davos runs under |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | davos's config location. This is where it stores its database file and logs. |
|
||||
| `/download` | davos's file download location |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -111,8 +99,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
The application does not require any set up other than starting the docker container. Further documentation can be found on the [davos GitHub repository page](https://github.com/linuxserver/davos).
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -129,3 +115,4 @@ The application does not require any set up other than starting the docker conta
|
|||
* **08.03.19:** - Updating build environment to pass proper build flags and use gradle wrapper.
|
||||
* **22.02.19:** - Rebasing to alpine 3.9.
|
||||
* **18.11.16:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/ddclient](https://github.com/linuxserver/docker-ddclient)
|
||||
# linuxserver/ddclient
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/ddclient "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/ddclient "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ddclient/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ddclient/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/ddclient) [](https://microbadger.com/images/linuxserver/ddclient)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ddclient/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ddclient/latest/index.html)
|
||||
|
||||
[Ddclient](https://sourceforge.net/p/ddclient/wiki/Home/) is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/ddclient` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=ddclient \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -42,7 +35,6 @@ docker create \
|
|||
linuxserver/ddclient
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -65,39 +57,37 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where ddclient should store its config files. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -106,8 +96,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Edit the ddclient.conf file found in your /config volume. This config file has many providers to choose from and you basically just have to uncomment your provider and add username/password where requested. If you modify ddclient.conf, ddclient will automaticcaly restart and read the config.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -131,3 +119,4 @@ Edit the ddclient.conf file found in your /config volume. This config file has m
|
|||
* **10.02.17:** - Rebase to alpine 3.5.
|
||||
* **26.11.16:** - Update README to new standard and add icon and other small details.
|
||||
* **29.08.16:** - Initial release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/domoticz](https://github.com/linuxserver/docker-domoticz)
|
||||
# linuxserver/domoticz
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/domoticz "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/domoticz "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/domoticz/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/domoticz) [](https://microbadger.com/images/linuxserver/domoticz)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-domoticz/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/domoticz/latest/index.html)
|
||||
|
||||
[Domoticz](https://www.domoticz.com) is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device.
|
||||
|
||||
|
|
@ -19,7 +13,7 @@ Simply pulling `linuxserver/domoticz` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
|
@ -29,8 +23,8 @@ The architectures supported by this image are:
|
|||
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
||||
|
||||
| Tag | Description |
|
||||
| :----: | --- |
|
||||
| latest | Current latest head from master at https://github.com/domoticz/domoticz. |
|
||||
| :---: | :--- |
|
||||
| latest | Current latest head from master at [https://github.com/domoticz/domoticz](https://github.com/domoticz/domoticz). |
|
||||
| stable | Latest stable version. |
|
||||
| stable-4.9700 | Old stable version. Will not be updated anymore! |
|
||||
| stable-3.815 | Old stable version. Will not be updated anymore! |
|
||||
|
|
@ -42,7 +36,7 @@ Here are some example snippets to help you get started creating a container from
|
|||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=domoticz \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -59,16 +53,16 @@ docker create \
|
|||
|
||||
### Passing Through USB Devices
|
||||
|
||||
To get full use of Domoticz, you probably have a USB device you want to pass through. To figure out which device to pass through, you have to connect the device and look in dmesg for the device node created. Issue the command 'dmesg | tail' after you connected your device and you should see something like below.
|
||||
To get full use of Domoticz, you probably have a USB device you want to pass through. To figure out which device to pass through, you have to connect the device and look in dmesg for the device node created. Issue the command 'dmesg \| tail' after you connected your device and you should see something like below.
|
||||
|
||||
```
|
||||
```text
|
||||
usb 1-1.2: new full-speed USB device number 7 using ehci-pci
|
||||
ftdi_sio 1-1.2:1.0: FTDI USB Serial Device converter detected
|
||||
usb 1-1.2: Detected FT232RL
|
||||
usb 1-1.2: FTDI USB Serial Device converter now attached to ttyUSB0
|
||||
```
|
||||
As you can see above, the device node created is ttyUSB0. It does not say where, but it's almost always in /dev/. The correct tag for passing through this USB device is '--device /dev/ttyUSB0:/dev/ttyUSB0'
|
||||
|
||||
As you can see above, the device node created is ttyUSB0. It does not say where, but it's almost always in /dev/. The correct tag for passing through this USB device is '--device /dev/ttyUSB0:/dev/ttyUSB0'
|
||||
|
||||
### docker-compose
|
||||
|
||||
|
|
@ -98,56 +92,52 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8080` | WebUI |
|
||||
| `6144` | Domoticz communication port. |
|
||||
| `1443` | Domoticz communication port. |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where Domoticz stores config files and data. |
|
||||
|
||||
#### Device Mappings (`--device`)
|
||||
| Parameter | Function |
|
||||
| :-----: | --- |
|
||||
| `<path to device>` | For passing through USB devices. |
|
||||
#### Device Mappings \(`--device`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| `<path to device>` | For passing through USB devices. |
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
To configure Domoticz, go to the IP of your docker host on the port you configured (default 8080), and add your hardware in Setup > Hardware.
|
||||
The user manual is available at [www.domoticz.com](https://www.domoticz.com)
|
||||
|
||||
|
||||
To configure Domoticz, go to the IP of your docker host on the port you configured \(default 8080\), and add your hardware in Setup > Hardware. The user manual is available at [www.domoticz.com](https://www.domoticz.com)
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -168,10 +158,11 @@ The user manual is available at [www.domoticz.com](https://www.domoticz.com)
|
|||
* **03.04.18:** - Add dependencies for BroadlinkRM2 plugin.
|
||||
* **20.01.18:** - Move telldus core to repo to prevent build fail when source site goes down.
|
||||
* **18.01.18:** - Remove logging to syslog in the run command to prevent double logging.
|
||||
* **04.01.18:** - Deprecate cpu_core routine lack of scaling.
|
||||
* **04.01.18:** - Deprecate cpu\_core routine lack of scaling.
|
||||
* **08.12.17:** - Rebase to alpine 3.7.
|
||||
* **26.11.17:** - Use cpu core counting routine to speed up build time.
|
||||
* **28.05.17:** - Rebase to alpine 3.6.
|
||||
* **26.02.17:** - Add curl and replace openssl with libressl.
|
||||
* **11.02.17:** - Update README.
|
||||
* **03.01.17:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,8 @@
|
|||
# [linuxserver/habridge](https://github.com/linuxserver/docker-habridge)
|
||||
# linuxserver/habridge
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/habridge "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/habridge "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-habridge/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/habridge/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/habridge) [](https://microbadger.com/images/linuxserver/habridge)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-habridge/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/habridge/latest/index.html)
|
||||
|
||||
[Habridge](http://bwssystems.com/#/habridge) emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 (gen 2 has issues discovering ha-bridge) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API.
|
||||
[Habridge](http://bwssystems.com/#/habridge) emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 \(gen 2 has issues discovering ha-bridge\) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API.
|
||||
|
||||
In the cases of systems that require authorization and/or have APIs that cannot be handled in the current method, a module may need to be built. The Harmony Hub is such a module and so is the Nest module. The Bridge has helpers to build devices for the gateway for the Logitech Harmony Hub, Vera, Vera Lite or Vera Edge, Nest, Somfy Tahoma, Home Assistant, Domoticz, MQTT, HAL, Fibaro, HomeWizard, LIFX, OpenHAB, FHEM, Broadlink and the ability to proxy all of your real Hue bridges behind this bridge.
|
||||
|
||||
|
|
@ -16,7 +10,6 @@ This bridge was built to help put the Internet of Things together.
|
|||
|
||||
For more information about how to use this software have a look at their Wiki [https://github.com/bwssytems/ha-bridge/wiki](https://github.com/bwssytems/ha-bridge/wiki)
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -26,19 +19,18 @@ Simply pulling `linuxserver/habridge` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=habridge \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -52,7 +44,6 @@ docker create \
|
|||
linuxserver/habridge
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -79,54 +70,49 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8080` | WebUI |
|
||||
| `50000` | HABridge communication port. |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `SEC_KEY=<Your Key To Encrypt Security Data>` | Key used to secure communication. |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where HABridge stores config files and data. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
To set up the ha-bridge simply go to http://localhost:8080. Once you are in the webui you can add devices and configure ha-bridge to your liking.
|
||||
To set up the ha-bridge simply go to [http://localhost:8080](http://localhost:8080). Once you are in the webui you can add devices and configure ha-bridge to your liking.
|
||||
|
||||
For information on how to configure ha-bridge, go to their wiki at [https://github.com/bwssytems/ha-bridge/wiki](https://github.com/bwssytems/ha-bridge/wiki)
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -145,3 +131,4 @@ For information on how to configure ha-bridge, go to their wiki at [https://gith
|
|||
* **28.08.18:** - Rebase to alpine 3.8.
|
||||
* **12.04.18:** - Add workaround to bind to port 80 if needed.
|
||||
* **08.04.18:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,8 @@
|
|||
# [linuxserver/lazylibrarian](https://github.com/linuxserver/docker-lazylibrarian)
|
||||
# linuxserver/lazylibrarian
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/index.html)
|
||||
|
||||
[Lazylibrarian](https://github.com/DobyTang/LazyLibrarian) is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/lazylibrarian) [](https://microbadger.com/images/linuxserver/lazylibrarian)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/index.html)
|
||||
|
||||
[Lazylibrarian](https://github.com/DobyTang/LazyLibrarian) is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -20,19 +13,18 @@ Simply pulling `linuxserver/lazylibrarian` should retrieve the correct image for
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=lazylibrarian \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -46,7 +38,6 @@ docker create \
|
|||
linuxserver/lazylibrarian
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -73,42 +64,39 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `5299` | The port for the LazyLibrarian webinterface |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use e.g. Europe/London |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | LazyLibrarian config |
|
||||
| `/downloads` | Download location |
|
||||
| `/books` | Books location |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -117,8 +105,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Access the webui at `http://<your-ip>:5299/home`, for more information check out [Lazylibrarian](https://github.com/DobyTang/LazyLibrarian).
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -136,7 +122,7 @@ Access the webui at `http://<your-ip>:5299/home`, for more information check out
|
|||
* **22.02.19:** - Rebasing to alpine 3.9.
|
||||
* **10.12.18:** - Moved to Pipeline Building
|
||||
* **16.08.18:** - Rebase to alpine 3.8
|
||||
* **05.01.18:** - Deprecate cpu_core routine lack of scaling
|
||||
* **05.01.18:** - Deprecate cpu\_core routine lack of scaling
|
||||
* **12.12.17:** - Rebase to alpine 3.7
|
||||
* **21.07.17:** - Internal git pull instead of at runtime
|
||||
* **25.05.17:** - Rebase to alpine 3.6
|
||||
|
|
@ -146,3 +132,4 @@ Access the webui at `http://<your-ip>:5299/home`, for more information check out
|
|||
* **14.10.16:** - Add version layer information
|
||||
* **03.10.16:** - Fix non-persistent settings and make log folder
|
||||
* **28.09.16:** - Inital Release
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/letsencrypt](https://github.com/linuxserver/docker-letsencrypt)
|
||||
# linuxserver/letsencrypt
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/letsencrypt "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/letsencrypt "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-letsencrypt/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/letsencrypt/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/letsencrypt) [](https://microbadger.com/images/linuxserver/letsencrypt)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-letsencrypt/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/letsencrypt/latest/index.html)
|
||||
|
||||
[Letsencrypt](https://letsencrypt.org/) sets up an Nginx webserver and reverse proxy with php support and a built-in letsencrypt client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/letsencrypt` should retrieve the correct image for y
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=letsencrypt \
|
||||
--cap-add=NET_ADMIN \
|
||||
|
|
@ -55,7 +48,6 @@ docker create \
|
|||
linuxserver/letsencrypt
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -94,51 +86,48 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `443` | Https port |
|
||||
| `80` | Http port (required for http validation only) |
|
||||
| `80` | Http port \(required for http validation only\) |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `URL=yourdomain.url` | Top url you have control over (`customdomain.com` if you own it, or `customsubdomain.ddnsprovider.com` if dynamic dns). |
|
||||
| `SUBDOMAINS=www,` | Subdomains you'd like the cert to cover (comma separated, no spaces) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` (wildcard cert is available via `dns` and `duckdns` validation only) |
|
||||
| `VALIDATION=http` | Letsencrypt validation method to use, options are `http`, `tls-sni`, `dns` or `duckdns` (`dns` method also requires `DNSPLUGIN` variable set) (`duckdns` method requires `DUCKDNSTOKEN` variable set, and the `SUBDOMAINS` variable set to `wildcard`). |
|
||||
| `URL=yourdomain.url` | Top url you have control over \(`customdomain.com` if you own it, or `customsubdomain.ddnsprovider.com` if dynamic dns\). |
|
||||
| `SUBDOMAINS=www,` | Subdomains you'd like the cert to cover \(comma separated, no spaces\) ie. `www,ftp,cloud`. For a wildcard cert, set this _exactly_ to `wildcard` \(wildcard cert is available via `dns` and `duckdns` validation only\) |
|
||||
| `VALIDATION=http` | Letsencrypt validation method to use, options are `http`, `tls-sni`, `dns` or `duckdns` \(`dns` method also requires `DNSPLUGIN` variable set\) \(`duckdns` method requires `DUCKDNSTOKEN` variable set, and the `SUBDOMAINS` variable set to `wildcard`\). |
|
||||
| `DNSPLUGIN=cloudflare` | Required if `VALIDATION` is set to `dns`. Options are `cloudflare`, `cloudxns`, `digitalocean`, `dnsimple`, `dnsmadeeasy`, `google`, `luadns`, `nsone`, `ovh`, `rfc2136` and `route53`. Also need to enter the credentials into the corresponding ini file under `/config/dns-conf`. |
|
||||
| `DUCKDNSTOKEN=<token>` | Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org |
|
||||
| `DUCKDNSTOKEN=<token>` | Required if `VALIDATION` is set to `duckdns`. Retrieve your token from [https://www.duckdns.org](https://www.duckdns.org) |
|
||||
| `EMAIL=<e-mail>` | Optional e-mail address used for cert expiration notifications. |
|
||||
| `DHLEVEL=2048` | Dhparams bit value (default=2048, can be set to `1024` or `4096`). |
|
||||
| `ONLY_SUBDOMAINS=false` | If you wish to get certs only for certain subdomains, but not the main domain (main domain may be hosted on another machine and cannot be validated), set this to `true` |
|
||||
| `EXTRA_DOMAINS=<extradomains>` | Additional fully qualified domain names (comma separated, no spaces) ie. `extradomain.com,subdomain.anotherdomain.org` |
|
||||
| `DHLEVEL=2048` | Dhparams bit value \(default=2048, can be set to `1024` or `4096`\). |
|
||||
| `ONLY_SUBDOMAINS=false` | If you wish to get certs only for certain subdomains, but not the main domain \(main domain may be hosted on another machine and cannot be validated\), set this to `true` |
|
||||
| `EXTRA_DOMAINS=<extradomains>` | Additional fully qualified domain names \(comma separated, no spaces\) ie. `extradomain.com,subdomain.anotherdomain.org` |
|
||||
| `STAGING=false` | Set to `true` to retrieve certs in staging mode. Rate limits will be much higher, but the resulting cert will not pass the browser's security test. Only to be used for testing purposes. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | All the config files including the webroot reside here. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -146,50 +135,58 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
## Application Setup
|
||||
|
||||
### Validation and initial setup
|
||||
* Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 (and/or 80) is not being used by another service on the host (NAS gui, another webserver, etc.).
|
||||
|
||||
* Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 \(and/or 80\) is not being used by another service on the host \(NAS gui, another webserver, etc.\).
|
||||
* For `http` validation, port 80 on the internet side of the router should be forwarded to this container's port 80
|
||||
* For `tls-sni` validation, port 443 on the internet side of the router should be forwarded to this container's port 443
|
||||
* For `dns` validation, make sure to enter your credentials into the corresponding ini file under `/config/dns-conf`
|
||||
* Cloudflare provides free accounts for managing dns and is very easy to use with this image. Make sure that it is set up for "dns only" instead of "dns + proxy"
|
||||
* Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
|
||||
* For `duckdns` validation, set the `SUBDOMAINS` variable to `wildcard`, and set the `DUCKDNSTOKEN` variable with your duckdns token. Due to a limitation of duckdns, the resulting cert will only cover the sub-subdomains (ie. `*.yoursubdomain.duckdns.org`) but will not cover `yoursubdomain.duckdns.org`. Therefore, it is recommended to use a sub-subdomain like `www.yoursubdomain.duckdns.org` for subfolders. You can use our [duckdns image](https://hub.docker.com/r/linuxserver/duckdns/) to update your IP on duckdns.org.
|
||||
* For `duckdns` validation, set the `SUBDOMAINS` variable to `wildcard`, and set the `DUCKDNSTOKEN` variable with your duckdns token. Due to a limitation of duckdns, the resulting cert will only cover the sub-subdomains \(ie. `*.yoursubdomain.duckdns.org`\) but will not cover `yoursubdomain.duckdns.org`. Therefore, it is recommended to use a sub-subdomain like `www.yoursubdomain.duckdns.org` for subfolders. You can use our [duckdns image](https://hub.docker.com/r/linuxserver/duckdns/) to update your IP on duckdns.org.
|
||||
* `--cap-add=NET_ADMIN` is required for fail2ban to modify iptables
|
||||
* If you need a dynamic dns provider, you can use the free provider duckdns.org where the `URL` will be `yoursubdomain.duckdns.org` and the `SUBDOMAINS` can be `www,ftp,cloud` with http validation, or `wildcard` with dns validation.
|
||||
* After setup, navigate to `https://yourdomain.url` to access the default homepage (http access through port 80 is disabled by default, you can enable it by editing the default site config at `/config/nginx/site-confs/default`).
|
||||
* After setup, navigate to `https://yourdomain.url` to access the default homepage \(http access through port 80 is disabled by default, you can enable it by editing the default site config at `/config/nginx/site-confs/default`\).
|
||||
* Certs are checked nightly and if expiration is within 30 days, renewal is attempted. If your cert is about to expire in less than 30 days, check the logs under `/config/log/letsencrypt` to see why the renewals have been failing. It is recommended to input your e-mail in docker parameters so you receive expiration notices from letsencrypt in those circumstances.
|
||||
### Security and password protection
|
||||
|
||||
**Security and password protection**
|
||||
|
||||
* The container detects changes to url and subdomains, revokes existing certs and generates new ones during start. It also detects changes to the DHLEVEL parameter and replaces the dhparams file.
|
||||
* If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it letsencrypt htpasswd -c /config/nginx/.htpasswd <username>`
|
||||
* You can add multiple user:pass to `.htpasswd`. For the first user, use the above command, for others, use the above command without the `-c` flag, as it will force deletion of the existing `.htpasswd` and creation of a new one
|
||||
* You can also use ldap auth for security and access control. A sample, user configurable ldap.conf is provided, and it requires the separate image [linuxserver/ldap-auth](https://hub.docker.com/r/linuxserver/ldap-auth/) to communicate with an ldap server.
|
||||
### Site config and reverse proxy
|
||||
|
||||
**Site config and reverse proxy**
|
||||
|
||||
* The default site config resides at `/config/nginx/site-confs/default`. Feel free to modify this file, and you can add other conf files to this directory. However, if you delete the `default` file, a new default will be created on container start.
|
||||
* Preset reverse proxy config files are added for popular apps. See the `_readme` file under `/config/nginx/proxy_confs` for instructions on how to enable them
|
||||
* If you wish to hide your site from search engine crawlers, you may find it useful to add this configuration line to your site config, within the server block, above the line where ssl.conf is included
|
||||
`add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";`
|
||||
This will *ask* Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines
|
||||
### Using certs in other containers
|
||||
|
||||
`add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";`
|
||||
|
||||
This will _ask_ Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines
|
||||
|
||||
**Using certs in other containers**
|
||||
|
||||
* This container includes auto-generated pfx and private-fullchain-bundle pem certs that are needed by other apps like Emby and Znc.
|
||||
* To use these certs in other containers, do either of the following:
|
||||
1. *(Easier)* Mount the letsencrypt config folder in other containers (ie. `-v /path-to-le-config:/le-ssl`) and in the other containers, use the cert location `/le-ssl/keys/letsencrypt/`
|
||||
2. *(More secure)* Mount the letsencrypt folder `etc/letsencrypt` that resides under `/config` in other containers (ie. `-v /path-to-le-config/etc/letsencrypt:/le-ssl`) and in the other containers, use the cert location `/le-ssl/live/<your.domain.url>/` (This is more secure because the first method shares the entire letsencrypt config folder with other containers, including the www files, whereas the second method only shares the ssl certs)
|
||||
* _\(Easier\)_ Mount the letsencrypt config folder in other containers \(ie. `-v /path-to-le-config:/le-ssl`\) and in the other containers, use the cert location `/le-ssl/keys/letsencrypt/`
|
||||
* _\(More secure\)_ Mount the letsencrypt folder `etc/letsencrypt` that resides under `/config` in other containers \(ie. `-v /path-to-le-config/etc/letsencrypt:/le-ssl`\) and in the other containers, use the cert location `/le-ssl/live/<your.domain.url>/` \(This is more secure because the first method shares the entire letsencrypt config folder with other containers, including the www files, whereas the second method only shares the ssl certs\)
|
||||
* These certs include:
|
||||
1. `cert.pem`, `chain.pem`, `fullchain.pem` and `privkey.pem`, which are generated by letsencrypt and used by nginx and various other apps
|
||||
2. `privkey.pfx`, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server (no password)
|
||||
3. `priv-fullchain-bundle.pem`, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
|
||||
### Using fail2ban
|
||||
* `cert.pem`, `chain.pem`, `fullchain.pem` and `privkey.pem`, which are generated by letsencrypt and used by nginx and various other apps
|
||||
* `privkey.pfx`, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server \(no password\)
|
||||
* `priv-fullchain-bundle.pem`, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
|
||||
|
||||
**Using fail2ban**
|
||||
* This container includes fail2ban set up with 3 jails by default:
|
||||
1. nginx-http-auth
|
||||
2. nginx-badbots
|
||||
3. nginx-botsearch
|
||||
* To enable or disable other jails, modify the file `/config/fail2ban/jail.local`
|
||||
* To modify filters and actions, instead of editing the `.conf` files, create `.local` files with the same name and edit those because .conf files get overwritten when the actions and filters are updated. `.local` files will append whatever's in the `.conf` files (ie. `nginx-http-auth.conf` --> `nginx-http-auth.local`)
|
||||
* To modify filters and actions, instead of editing the `.conf` files, create `.local` files with the same name and edit those because .conf files get overwritten when the actions and filters are updated. `.local` files will append whatever's in the `.conf` files \(ie. `nginx-http-auth.conf` --> `nginx-http-auth.local`\)
|
||||
* You can check which jails are active via `docker exec -it letsencrypt fail2ban-client status`
|
||||
* You can check the status of a specific jail via `docker exec -it letsencrypt fail2ban-client status <jail name>`
|
||||
* You can unban an IP via `docker exec -it letsencrypt fail2ban-client set <jail name> unbanip <IP>`
|
||||
* A list of commands can be found here: https://www.fail2ban.org/wiki/index.php/Commands
|
||||
|
||||
|
||||
* A list of commands can be found here: [https://www.fail2ban.org/wiki/index.php/Commands](https://www.fail2ban.org/wiki/index.php/Commands)
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -210,8 +207,8 @@ This will *ask* Google et al not to index and list your site. Be careful with th
|
|||
* **22.02.19:** - Rebase to alpine 3.9.
|
||||
* **03.02.19:** - Removed memcached due to seccomp errors. Let us know if you need to re-enable memcached.
|
||||
* **28.01.19:** - Add pipeline logic and multi arch.
|
||||
* **21.01.19:** - Remove client_body_max from proxy.conf (existing users need to manually update).
|
||||
* **09.01.19:** - Remove tls v1 and v1.1 from default ssl.conf, update ciphers (existing users need to manually update).
|
||||
* **21.01.19:** - Remove client\_body\_max from proxy.conf \(existing users need to manually update\).
|
||||
* **09.01.19:** - Remove tls v1 and v1.1 from default ssl.conf, update ciphers \(existing users need to manually update\).
|
||||
* **30.12.18:** - Fix bundle key generation.
|
||||
* **19.12.18:** - Add ipv6 and http/2 support to default site config.
|
||||
* **08.12.18:** - Had to remove cert renewal during container start due to certbot's new undocumented `feature` of up to 8 minute random delay.
|
||||
|
|
@ -220,31 +217,31 @@ This will *ask* Google et al not to index and list your site. Be careful with th
|
|||
* **20.11.18:** - Externalize reverse proxy confs to separate github repo `linuxserver/reverse-proxy-confs`, update baseimage packages during build
|
||||
* **19.11.18:** - Add php opcache package.
|
||||
* **12.11.18:** - Add support for duckdns wildcard certs via dns validation
|
||||
* **31.10.18:** - Add various preset proxy confs and fix others (thanks @nemchik and @hijxf)
|
||||
* **31.10.18:** - Add various preset proxy confs and fix others \(thanks @nemchik and @hijxf\)
|
||||
* **02.10.18:** - Fix fail2ban instructions and logrotate conf
|
||||
* **11.09.18:** - Add various preset proxy confs and fix others (thanks @nemchik and @LeoVerto)
|
||||
* **11.09.18:** - Add various preset proxy confs and fix others \(thanks @nemchik and @LeoVerto\)
|
||||
* **04.09.18:** - Linting fixes.
|
||||
* **30.08.18:** - Add support for ldap auth, add proxy confs for bazarr, couchpotato, headphones, lidarr and plex subfolder (thanks @nemchik and @jedahan)
|
||||
* **30.08.18:** - Add support for ldap auth, add proxy confs for bazarr, couchpotato, headphones, lidarr and plex subfolder \(thanks @nemchik and @jedahan\)
|
||||
* **21.08.18:** - Rebase to alpine 3.8, add info on search engine de-listing
|
||||
* **08.08.18:** - Add subdomain proxy conf for plex, update emby proxy confs
|
||||
* **25.07.18:** - Add subdomain proxy conf for syncthing
|
||||
* **23.07.18:** - Remove backwards compatibility and set default validation method to http. Update portainer proxy config to fix websockets. Add unifi proxy conf.
|
||||
* **31.05.18:** - Update ssl.conf and proxy.conf for tighter security (thanks @nemchik)
|
||||
* **30.05.18:** - Add reverse proxy configs for jackett, monitorr, nzbget, nzbhydra, organizr, portainer and transmission (thanks @nemchik)
|
||||
* **31.05.18:** - Update ssl.conf and proxy.conf for tighter security \(thanks @nemchik\)
|
||||
* **30.05.18:** - Add reverse proxy configs for jackett, monitorr, nzbget, nzbhydra, organizr, portainer and transmission \(thanks @nemchik\)
|
||||
* **18.05.18:** - Add more info on certs and unraid reverse proxy config
|
||||
* **11.05.18:** - Add php pgsql support
|
||||
* **24.04.18:** - Auto generate a private key + fullchain bundle pem that is needed by certain apps
|
||||
* **20.04.18:** - Add standardized optional reverse proxy conf files
|
||||
* **19.04.18:** - Bind memcached to localhost only, add php7-sqlite3
|
||||
* **08.04.18:** - Fix renewal hooks
|
||||
* **29.03.18:** - Create pfx cert after renewal for dns validation (previous version only created it for http and tls, an oversight)
|
||||
* **29.03.18:** - Create pfx cert after renewal for dns validation \(previous version only created it for http and tls, an oversight\)
|
||||
* **29.03.18:** - Fix staging for v2 api
|
||||
* **13.03.18:** - Support for wildcard cert with dns validation added. Switched to v2 api for ACME.
|
||||
* **21.02.18:** - Reduce shellcheck directives by renaming secondary variables
|
||||
* **20.02.18:** - Sanitize variables, increase log verbosity
|
||||
* **01.02.18:** - Big changes. `VALIDATION` parameter added for choosing letsencrypt validation methods, including dns through official plugins. `HTTPVAL` is deprecated. `STAGING` parameter added for testing. Backwards compatibility for the short term. Since tls-sni is disabled by letsencrypt, most users will have to change their settings and adopt the new parameters within the next 90 days. Reorganized the nginx default config, split ssl settings into new ssl.conf
|
||||
* **13.01.18:** - Re-enable ipv6 due to update to fail2ban 0.10.1. Existing users can enable ipv6 by deleting `/config/fail2ban/action.d/iptables-common.local` and restarting the container after updating the image
|
||||
* **11.01.18:** - Halt the container if validation fails instead of a stop (so restart=always doesn't get users throttled with letsencrypt)
|
||||
* **11.01.18:** - Halt the container if validation fails instead of a stop \(so restart=always doesn't get users throttled with letsencrypt\)
|
||||
* **10.01.18:** - Add option for http validation on port 80
|
||||
* **05.01.18:** - Rebase to alpine 3.7
|
||||
* **04.11.17:** - Add php7 soap module
|
||||
|
|
@ -254,18 +251,19 @@ This will *ask* Google et al not to index and list your site. Be careful with th
|
|||
* **01.09.17:** - `--privileged` is no longer required as long as `--cap-add=NET_ADMIN` is added, instructions modified accordingly, disabled fail2ban ipv6 actions due to requiring access to host kernel modules
|
||||
* **31.08.17:** - Add php7-phar
|
||||
* **14.07.17:** - Enable modules dynamically in nginx.conf
|
||||
* **06.07.17:** - Add support for multiple domains (thanks @oznu)
|
||||
* **06.07.17:** - Add support for multiple domains \(thanks @oznu\)
|
||||
* **22.06.17:** - Add various nginx modules and enable all modules in the default nginx.conf
|
||||
* **16.06.17:** - Update deprecated certbot option for https validation, make e-mail entry optional, update readme
|
||||
* **05.06.17:** - Add php7-bz2
|
||||
* **27.05.17:** - Rebase to alpine 3.6.
|
||||
* **03.05.17:** - Fix log permissions.
|
||||
* **18.04.17:** - Add php7-sockets, update fail2ban filter and action defaults
|
||||
* **27.02.17:** - Add php7-dom, php7-iconv and php7-pdo_sqlite
|
||||
* **27.02.17:** - Add php7-dom, php7-iconv and php7-pdo\_sqlite
|
||||
* **21.02.17:** - Add php7-xml
|
||||
* **10.02.17:** - Switch to alpine 3.5 base and php7, add php zlib module and all nginx modules
|
||||
* **13.01.17:** - Add php5-ctype and php5-openssl
|
||||
* **04.01.17:** - Add php5-mysqli and php5-pdo_mysql
|
||||
* **04.01.17:** - Add php5-mysqli and php5-pdo\_mysql
|
||||
* **22.11.16:** - Add gd and mcrypt packages
|
||||
* **21.11.16:** - Add curl package
|
||||
* **07.11.16:** - Initial Release
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/lidarr](https://github.com/linuxserver/docker-lidarr)
|
||||
# linuxserver/lidarr
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lidarr/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/lidarr) [](https://microbadger.com/images/linuxserver/lidarr)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lidarr/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/index.html)
|
||||
|
||||
[Lidarr](https://github.com/lidarr/Lidarr) is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
|
||||
|
||||
|
|
@ -19,7 +13,7 @@ Simply pulling `linuxserver/lidarr` should retrieve the correct image for your a
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
|
@ -29,7 +23,7 @@ The architectures supported by this image are:
|
|||
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
||||
|
||||
| Tag | Description |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| latest | Stable Lidarr releases. |
|
||||
| preview | Nightly Lidarr Releases. |
|
||||
|
||||
|
|
@ -39,7 +33,7 @@ Here are some example snippets to help you get started creating a container from
|
|||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=lidarr \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -53,7 +47,6 @@ docker create \
|
|||
linuxserver/lidarr
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -80,42 +73,39 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8686` | Application WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Configuration files for Lidarr. |
|
||||
| `/music` | Music files. |
|
||||
| `/downloads` | Path to your download folder for music. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -124,8 +114,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Access the webui at `<your-ip>:8686`, for more information check out [Lidarr](https://github.com/lidarr/Lidarr).
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -142,6 +130,7 @@ Access the webui at `<your-ip>:8686`, for more information check out [Lidarr](ht
|
|||
* **08.03.19:** - Rebase to Bionic, use proposed endpoint for libchromaprint.
|
||||
* **26.01.19:** - Add pipeline logic and multi arch.
|
||||
* **22.04.18:** - Switch to beta builds.
|
||||
* **17.03.18:** - Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix.
|
||||
* **17.03.18:** - Add ENV XDG\_CONFIG\_HOME="/config/xdg" to Dockerfile for signalr fix.
|
||||
* **27.02.18:** - Use json to query for new version.
|
||||
* **23.02.18:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb)
|
||||
# linuxserver/mariadb
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/mariadb "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/mariadb "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/mariadb) [](https://microbadger.com/images/linuxserver/mariadb)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/index.html)
|
||||
|
||||
[Mariadb](https://mariadb.org/) is one of the most popular database servers. Made by the original developers of MySQL.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/mariadb` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=mariadb \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -47,7 +40,6 @@ docker create \
|
|||
linuxserver/mariadb
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -76,64 +68,56 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `3306` | Mariadb listens on this port. |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `MYSQL_ROOT_PASSWORD=<DATABASE PASSWORD>` | Set this to root password for installation (minimum 4 characters). |
|
||||
| `MYSQL_ROOT_PASSWORD=<DATABASE PASSWORD>` | Set this to root password for installation \(minimum 4 characters\). |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `MYSQL_DATABASE=<USER DB NAME>` | Specify the name of a database to be created on image startup. |
|
||||
| `MYSQL_USER=<MYSQL USER>` | This user will have superuser access to the database specified by MYSQL_DATABASE. |
|
||||
| `MYSQL_PASSWORD=<DATABASE PASSWORD>` | Set this to the password you want to use for you MYSQL_USER (minimum 4 characters). |
|
||||
| `MYSQL_USER=<MYSQL USER>` | This user will have superuser access to the database specified by MYSQL\_DATABASE. |
|
||||
| `MYSQL_PASSWORD=<DATABASE PASSWORD>` | Set this to the password you want to use for you MYSQL\_USER \(minimum 4 characters\). |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Contains the db itself and all assorted settings. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
If you didn't set a password during installation, (see logs for warning) use
|
||||
`mysqladmin -u root password <PASSWORD>`
|
||||
to set one at the docker prompt...
|
||||
If you didn't set a password during installation, \(see logs for warning\) use `mysqladmin -u root password <PASSWORD>` to set one at the docker prompt...
|
||||
|
||||
NOTE changing the MYSQL_ROOT_PASSWORD variable after the container has set up the initial databases has no effect, use the mysqladmin tool to change your mariadb password.
|
||||
NOTE changing the MYSQL\_ROOT\_PASSWORD variable after the container has set up the initial databases has no effect, use the mysqladmin tool to change your mariadb password.
|
||||
|
||||
NOTE if you want to use (MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD) **all three** of these variables need to be set you cannot pick and choose.
|
||||
NOTE if you want to use \(MYSQL\_DATABASE MYSQL\_USER MYSQL\_PASSWORD\) **all three** of these variables need to be set you cannot pick and choose.
|
||||
|
||||
Unraid users, it is advisable to edit the template/webui after setup and remove reference to this variable.
|
||||
|
||||
Find custom.cnf in /config for config changes (restart container for them to take effect)
|
||||
, the databases in /config/databases and the log in /config/log/myqsl
|
||||
|
||||
|
||||
Find custom.cnf in /config for config changes \(restart container for them to take effect\) , the databases in /config/databases and the log in /config/log/myqsl
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -156,6 +140,7 @@ Find custom.cnf in /config for config changes (restart container for them to tak
|
|||
* **27.10.16:** - Implement linting suggestions on database init script.
|
||||
* **11.10.16:** - Rebase to ubuntu xenial, add version labelling.
|
||||
* **09.03.16:** - Update to mariadb 10.1. Change to use custom.cnf over my.cnf in /config. Restructured init files to change config options on startup, rather than in the dockerfile.
|
||||
* **26.01.16:** - Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.
|
||||
* **26.01.16:** - Change user of mysqld\_safe script to abc, better unclean shutdown handling on restart.
|
||||
* **23.12.15:** - Remove autoupdating, between some version updates the container breaks.
|
||||
* **12.08.15:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/musicbrainz](https://github.com/linuxserver/docker-musicbrainz)
|
||||
# linuxserver/musicbrainz
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/musicbrainz "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/musicbrainz "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-musicbrainz/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/musicbrainz/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/musicbrainz) [](https://microbadger.com/images/linuxserver/musicbrainz)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-musicbrainz/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/musicbrainz/latest/index.html)
|
||||
|
||||
[Musicbrainz](https://musicbrainz.org/) is an open music encyclopedia that collects music metadata and makes it available to the public.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/musicbrainz` should retrieve the correct image for y
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=musicbrainz \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -47,7 +40,6 @@ docker create \
|
|||
linuxserver/musicbrainz
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -76,19 +68,18 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `5000` | WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
|
|
@ -96,40 +87,34 @@ Docker images are configured using parameters passed at runtime (such as those a
|
|||
| `WEBADDRESS=<ip of host>` | To set ip for host to allow css to render properly, DO NOT ENTER PORT NUMBER. |
|
||||
| `NPROC=<parameter>` | To set number of proceses, defaults to 5 if unset. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Config files for musicbrainz. |
|
||||
| `/data` | Data files for musicbrainz. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
+ For all updates you should pull the latest image, clear all files and folders in /config and /data and reinitiate the database import by (re)starting the docker. We do not officially support upgrading this container in place with existing data sets.
|
||||
|
||||
+ **If you did not set WEBADDRESS env variable, then AFTER iniatilisation is complete you will need to edit the line `sub WEB_SERVER { "localhost:5000" }` in file /config/DBDefs.pm changing localhost to the ip of your host, this is to allow css to display properly**
|
||||
|
||||
* For all updates you should pull the latest image, clear all files and folders in /config and /data and reinitiate the database import by \(re\)starting the docker. We do not officially support upgrading this container in place with existing data sets.
|
||||
* **If you did not set WEBADDRESS env variable, then AFTER iniatilisation is complete you will need to edit the line** `sub WEB_SERVER { "localhost:5000" }` **in file /config/DBDefs.pm changing localhost to the ip of your host, this is to allow css to display properly**
|
||||
* You must register here to recieve a musicbrainz code to allow you to recieve database updates, it is free. [Get Code here](https://metabrainz.org/supporters/account-type).
|
||||
* The initial import and setup of the database can take quite a long time, dependant on your download speed etc, be patient and don't restart the container before it's complete.
|
||||
* It appears there are issues with unraid and using /mnt/user/cache/appdata instead of /mnt/cache/appdata, use /mnt/cache/appdata.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -156,7 +141,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
* **31.11.17:** - Bump server version 2017-12-21.
|
||||
* **30.11.17:** - Add NPROC variable to allow number of processes to be set.
|
||||
* **30.11.17:** - Fix linting recommendations.
|
||||
* **30.11.17:** - Remove socket on startup if exists (thanks wtf911) [re](https://tickets.metabrainz.org/browse/MBS-9370).
|
||||
* **30.11.17:** - Remove socket on startup if exists \(thanks wtf911\) [re](https://tickets.metabrainz.org/browse/MBS-9370).
|
||||
* **24.11.17:** - Remove catalyst side bar on new installs.
|
||||
* **31.10.17:** - Bump server version 2017-10-31.
|
||||
* **20.09.17:** - Bump server version 2017-09-18.
|
||||
|
|
@ -185,3 +170,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
* **03.01.16:** - Remove d/l of sitemaps file, missing from last 2 db dumps, move fetch of db/dump higher up initialise routine to allow easier resume of broken downloads.
|
||||
* **15.12.15:** - Per latest musicbrainz blog, switched to production branch,latest stable code is now production branch in place of master.
|
||||
* **10.12.15:** - Initial release date.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/openvpn-as](https://github.com/linuxserver/docker-openvpn-as)
|
||||
# linuxserver/openvpn-as
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/openvpn-as "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/openvpn-as "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-openvpn-as/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/openvpn-as/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/openvpn-as) [](https://microbadger.com/images/linuxserver/openvpn-as)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-openvpn-as/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/openvpn-as/latest/index.html)
|
||||
|
||||
[Openvpn-as](https://openvpn.net/index.php/access-server/overview.html) is a full featured secure network tunneling VPN software solution that integrates OpenVPN server capabilities, enterprise management capabilities, simplified OpenVPN Connect UI, and OpenVPN Client software packages that accommodate Windows, MAC, Linux, Android, and iOS environments. OpenVPN Access Server supports a wide range of configurations, including secure and granular remote access to internal network and/ or private cloud network resources and applications with fine-grained access control.
|
||||
|
||||
|
|
@ -19,17 +13,16 @@ Simply pulling `linuxserver/openvpn-as` should retrieve the correct image for yo
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=openvpn-as \
|
||||
--cap-add=NET_ADMIN \
|
||||
|
|
@ -45,7 +38,6 @@ docker create \
|
|||
linuxserver/openvpn-as
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -75,43 +67,40 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `943` | Admin GUI port. |
|
||||
| `9443` | TCP port. |
|
||||
| `1194/udp` | UDP port. |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `INTERFACE=eth0` | With bridge networking, leave it as eth0 (or don't include at all), if host or macvlan, set it to your host's network interface, found by running `ifconfig` |
|
||||
| `INTERFACE=eth0` | With bridge networking, leave it as eth0 \(or don't include at all\), if host or macvlan, set it to your host's network interface, found by running `ifconfig` |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where openvpn-as should store configuration files. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -120,15 +109,9 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
The admin interface is available at `https://<ip>:943/admin` with a default user/password of admin/password
|
||||
|
||||
During first login, make sure that the "Authentication" in the webui is set to "Local" instead of "PAM". Then set up the user accounts with their passwords (user accounts created under PAM do not survive container update or recreation).
|
||||
|
||||
The "admin" account is a system (PAM) account and after container update or recreation, its password reverts back to the default. It is highly recommended to block this user's access for security reasons:
|
||||
1) Create another user and set as an admin,
|
||||
2) Log in as the new user,
|
||||
3) Delete the "admin" user in the gui,
|
||||
4) Modify the `as.conf` file under config/etc and replace the line `boot_pam_users.0=admin` with `#boot_pam_users.0=admin` (this only has to be done once and will survive container recreation)
|
||||
|
||||
During first login, make sure that the "Authentication" in the webui is set to "Local" instead of "PAM". Then set up the user accounts with their passwords \(user accounts created under PAM do not survive container update or recreation\).
|
||||
|
||||
The "admin" account is a system \(PAM\) account and after container update or recreation, its password reverts back to the default. It is highly recommended to block this user's access for security reasons: 1\) Create another user and set as an admin, 2\) Log in as the new user, 3\) Delete the "admin" user in the gui, 4\) Modify the `as.conf` file under config/etc and replace the line `boot_pam_users.0=admin` with `#boot_pam_users.0=admin` \(this only has to be done once and will survive container recreation\)
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -164,3 +147,4 @@ The "admin" account is a system (PAM) account and after container update or recr
|
|||
* **28.08.16:** - Add badges to README.
|
||||
* **01.08.16:** - Rebase to xenial.
|
||||
* **18.09.15:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/projectsend](https://github.com/linuxserver/docker-projectsend)
|
||||
# linuxserver/projectsend
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/projectsend "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/projectsend "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-projectsend/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/projectsend/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/projectsend) [](https://microbadger.com/images/linuxserver/projectsend)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-projectsend/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/projectsend/latest/index.html)
|
||||
|
||||
[Projectsend](http://www.projectsend.org) is a self-hosted application that lets you upload files and assign them to specific clients that you create yourself. Secure, private and easy. No more depending on external services or e-mail to send those files.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/projectsend` should retrieve the correct image for y
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=projectsend \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -45,7 +38,6 @@ docker create \
|
|||
linuxserver/projectsend
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -72,42 +64,39 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `80` | WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `MAX_UPLOAD=<5000>` | To set maximum upload size (in MB), default if unset is 5000. |
|
||||
| `MAX_UPLOAD=<5000>` | To set maximum upload size \(in MB\), default if unset is 5000. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where to store projectsend config files. |
|
||||
| `/data` | Where to store files to share. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -120,8 +109,6 @@ On first run go to `<your-ip>/install/make-config.php` and enter your database d
|
|||
|
||||
More info at [ProjectSend](http://www.projectsend.org).
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -139,3 +126,4 @@ More info at [ProjectSend](http://www.projectsend.org).
|
|||
* **11.06.17:** - Fetch version from github.
|
||||
* **09.12.17:** - Rebase to alpine 3.7.
|
||||
* **13.06.17:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,8 @@
|
|||
# [linuxserver/pydio](https://github.com/linuxserver/docker-pydio)
|
||||
# linuxserver/pydio
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/pydio "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/pydio "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-pydio/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/pydio/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/pydio) [](https://microbadger.com/images/linuxserver/pydio)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-pydio/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/pydio/latest/index.html)
|
||||
|
||||
[Pydio](https://pydio.com/) (formerly AjaXplorer) is a mature open source software solution for file sharing and synchronization. With intuitive user interfaces (web / mobile / desktop), Pydio provides enterprise-grade features to gain back control and privacy of your data: user directory connectors, legacy filesystems drivers, comprehensive admin interface, and much more.
|
||||
[Pydio](https://pydio.com/) \(formerly AjaXplorer\) is a mature open source software solution for file sharing and synchronization. With intuitive user interfaces \(web / mobile / desktop\), Pydio provides enterprise-grade features to gain back control and privacy of your data: user directory connectors, legacy filesystems drivers, comprehensive admin interface, and much more.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/pydio` should retrieve the correct image for your ar
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=pydio \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -44,7 +37,6 @@ docker create \
|
|||
linuxserver/pydio
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -70,49 +62,45 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `443` | WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where pydio should store it's configuration files. |
|
||||
| `/data` | Where pydio should store uploaded files. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
You must create a user and database for pydio to use in a mysql/mariadb or postgresql server. You can use sqlite with no further config needed, but this should only be considered for testing purposes.
|
||||
In the setup page for database, use the ip address rather than hostname...
|
||||
You must create a user and database for pydio to use in a mysql/mariadb or postgresql server. You can use sqlite with no further config needed, but this should only be considered for testing purposes. In the setup page for database, use the ip address rather than hostname...
|
||||
|
||||
Self-signed keys are generated the first time you run the container and can be found in /config/keys , if needed, you can replace them with your own.
|
||||
|
||||
|
|
@ -120,8 +108,6 @@ For public link sharing to function correctly be sure to change the Detected Ser
|
|||
|
||||
For email settings edit the file /config/ssmtp.conf and restart the container.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -147,3 +133,4 @@ For email settings edit the file /config/ssmtp.conf and restart the container.
|
|||
* **14.10.16:** - Add version layer information.
|
||||
* **10.09.16:** - Add layer badges to README.
|
||||
* **08.09.15:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,9 @@
|
|||
# [linuxserver/sickchill](https://github.com/linuxserver/docker-sickchill)
|
||||
# linuxserver/sickchill
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/sickchill "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/sickchill "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickchill/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickchill/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/sickchill) [](https://microbadger.com/images/linuxserver/sickchill)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickchill/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickchill/latest/index.html)
|
||||
|
||||
[Sickchill](https://github.com/SickChill/SickChill) is an Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -20,19 +13,18 @@ Simply pulling `linuxserver/sickchill` should retrieve the correct image for you
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=sickchill \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -48,7 +40,6 @@ docker create \
|
|||
linuxserver/sickchill
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -77,44 +68,41 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8081` | will map the container's port 8081 to port 8081 on the host |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `PGID=<yourUID>` | specify your UID |
|
||||
| `PUID=<yourGID>` | specify your GID |
|
||||
| `TZ=<yourdbpass>` | specify your TimeZone e.g. Europe/London |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | this will store config on the docker host |
|
||||
| `/downloads` | this will store any downloaded data on the docker host |
|
||||
| `/tv` | this will allow sickchill to view what you already have |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -123,8 +111,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -139,3 +125,4 @@ Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to matc
|
|||
## Versions
|
||||
|
||||
* **10.10.18:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/sickrage](https://github.com/linuxserver/docker-sickrage)
|
||||
# linuxserver/sickrage
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/sickrage "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/sickrage "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickrage/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickrage/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/sickrage) [](https://microbadger.com/images/linuxserver/sickrage)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickrage/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickrage/latest/index.html)
|
||||
|
||||
[Sickrage](https://sick-rage.github.io/) is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/sickrage` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=sickrage \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -45,7 +38,6 @@ docker create \
|
|||
linuxserver/sickrage
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -72,42 +64,39 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `8081` | Application WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Configuration files. |
|
||||
| `/downloads` | ISOs. |
|
||||
| `/tv` | TV library directory. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
|
@ -116,7 +105,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
|||
|
||||
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui.
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -147,3 +135,4 @@ Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to matc
|
|||
* **30.12.15:** - Build later version of unrar from source, removed uneeded mako package.
|
||||
* **20.11.15:** - Updated to new repo, by SickRage Team.
|
||||
* **15.10.15:** - Initial Release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,23 +1,15 @@
|
|||
# [linuxserver/taisun](https://github.com/linuxserver/docker-taisun)
|
||||
# linuxserver/taisun
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/taisun "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/taisun "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-taisun/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/taisun/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/taisun) [](https://microbadger.com/images/linuxserver/taisun)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-taisun/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/taisun/latest/index.html)
|
||||
|
||||
[Taisun](https://www.taisun.io/) is an application for a Docker enabled device with an emphasis on providing a web based interface for managing a single server.
|
||||
Taisun allows you to:
|
||||
|
||||
- Deploy and manage web based virtual desktops.
|
||||
- Deploy Taisun specific stacks of applications
|
||||
- Browse available images on popular Docker repositories
|
||||
- Import a Docker project from any git repository and start developing on your choice of web based IDE or full Linux desktop
|
||||
- Spinup a developer container based on popular frameworks and work from a web based IDE
|
||||
- Single click remote server access to Taisun and your Docker applications
|
||||
[Taisun](https://www.taisun.io/) is an application for a Docker enabled device with an emphasis on providing a web based interface for managing a single server. Taisun allows you to:
|
||||
|
||||
* Deploy and manage web based virtual desktops.
|
||||
* Deploy Taisun specific stacks of applications
|
||||
* Browse available images on popular Docker repositories
|
||||
* Import a Docker project from any git repository and start developing on your choice of web based IDE or full Linux desktop
|
||||
* Spinup a developer container based on popular frameworks and work from a web based IDE
|
||||
* Single click remote server access to Taisun and your Docker applications
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -28,19 +20,18 @@ Simply pulling `linuxserver/taisun` should retrieve the correct image for your a
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=taisun \
|
||||
-p 3000:3000 \
|
||||
|
|
@ -49,7 +40,6 @@ docker create \
|
|||
linuxserver/taisun
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -70,33 +60,29 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `3000` | Taisun WebUI. |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/var/run/docker.sock` | Docker Socket on the system |
|
||||
|
||||
|
||||
|
||||
## Application Setup
|
||||
|
||||
The webui is at http://localhost:3000, for more information on usage see [here](https://github.com/Taisun-Docker/taisun/wiki/Usage).
|
||||
|
||||
|
||||
The webui is at [http://localhost:3000](http://localhost:3000), for more information on usage see [here](https://github.com/Taisun-Docker/taisun/wiki/Usage).
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -112,3 +98,4 @@ The webui is at http://localhost:3000, for more information on usage see [here](
|
|||
## Versions
|
||||
|
||||
* **13.02.19:** - Initial release.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,9 @@
|
|||
# [linuxserver/unifi-controller](https://github.com/linuxserver/docker-unifi-controller)
|
||||
# linuxserver/unifi-controller
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/unifi-controller "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/unifi-controller "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-unifi-controller/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/unifi-controller/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/unifi-controller) [](https://microbadger.com/images/linuxserver/unifi-controller)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-unifi-controller/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/unifi-controller/latest/index.html)
|
||||
|
||||
The [Unifi-controller](https://www.ubnt.com/enterprise/#unifi) Controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
|
||||
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
|
@ -20,19 +13,18 @@ Simply pulling `linuxserver/unifi-controller` should retrieve the correct image
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=unifi-controller \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -55,7 +47,7 @@ docker create \
|
|||
This image provides various versions that are available via tags. `latest` tag provides the latest stable build from Unifi, but if this is a permanent setup you might consider using the LTS tag.
|
||||
|
||||
| Tag | Description |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| latest | releases from the latest stable branch. |
|
||||
| LTS | releases from the 5.6.x "LTS Stable" branch. |
|
||||
| 5.9 | releases from the 5.9.x branch. |
|
||||
|
|
@ -63,8 +55,8 @@ This image provides various versions that are available via tags. `latest` tag p
|
|||
| 5.7 | releases from the 5.7.x branch. |
|
||||
|
||||
## Common problems
|
||||
When using a Security Gateway (router) it could be that network connected devices are unable to obtain an ip address. This can be fixed by setting "DHCP Gateway IP", under Settings > Networks > network_name, to a correct (and accessable) ip address.
|
||||
|
||||
When using a Security Gateway \(router\) it could be that network connected devices are unable to obtain an ip address. This can be fixed by setting "DHCP Gateway IP", under Settings > Networks > network\_name, to a correct \(and accessable\) ip address.
|
||||
|
||||
### docker-compose
|
||||
|
||||
|
|
@ -96,12 +88,12 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `3478/udp` | Unifi communication port |
|
||||
| `10001/udp` | required for AP discovery |
|
||||
| `8080` | required for Unifi to function |
|
||||
|
|
@ -111,44 +103,41 @@ Docker images are configured using parameters passed at runtime (such as those a
|
|||
| `8880` | Unifi communication port |
|
||||
| `6789` | For throughput test |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | All Unifi data stored here |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
The webui is at https://ip:8443, setup with the first run wizard.
|
||||
The webui is at [https://ip:8443](https://ip:8443), setup with the first run wizard.
|
||||
|
||||
For Unifi to adopt other devices, e.g. an Access Point, it is required to change the inform ip address. Because Unifi runs inside Docker by default it uses an ip address not accessable by other devices. To change this go to Settings > Controller > Controller Settings and set the Controller Hostname/IP to an ip address accessable by other devices.
|
||||
For Unifi to adopt other devices, e.g. an Access Point, it is required to change the inform ip address. Because Unifi runs inside Docker by default it uses an ip address not accessable by other devices. To change this go to Settings > Controller > Controller Settings and set the Controller Hostname/IP to an ip address accessable by other devices.
|
||||
|
||||
Alternatively to manually adopt a device take these steps:
|
||||
|
||||
```
|
||||
```text
|
||||
ssh ubnt@$AP-IP
|
||||
mca-cli
|
||||
set-inform http://$address:8080/inform
|
||||
|
|
@ -156,8 +145,6 @@ set-inform http://$address:8080/inform
|
|||
|
||||
Use `ubnt` as the password to login and `$address` is the IP address of the host you are running this container on and `$AP-IP` is the Access Point IP address.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -172,3 +159,4 @@ Use `ubnt` as the password to login and `$address` is the IP address of the host
|
|||
## Versions
|
||||
|
||||
* **10.02.19:** - Initial release of new unifi-controller image with new tags and pipeline logic
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
# [linuxserver/webgrabplus](https://github.com/linuxserver/docker-webgrabplus)
|
||||
# linuxserver/webgrabplus
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/webgrabplus "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/webgrabplus "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webgrabplus/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/webgrabplus/latest/index.html)
|
||||
[](https://discord.gg/YWrKVTn) [](https://microbadger.com/images/linuxserver/webgrabplus) [](https://microbadger.com/images/linuxserver/webgrabplus)   [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webgrabplus/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/webgrabplus/latest/index.html)
|
||||
|
||||
[Webgrabplus](http://www.webgrabplus.com) is a multi-site incremental xmltv epg grabber. It collects tv-program guide data from selected tvguide sites for your favourite channels.
|
||||
|
||||
|
|
@ -19,19 +13,18 @@ Simply pulling `linuxserver/webgrabplus` should retrieve the correct image for y
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
```text
|
||||
docker create \
|
||||
--name=webgrabplus \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -43,7 +36,6 @@ docker create \
|
|||
linuxserver/webgrabplus
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -67,61 +59,57 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
### Volume Mappings \(`-v`\)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| :---: | :--- |
|
||||
| `/config` | Where webgrabplus should store it's config files. |
|
||||
| `/data` | Where webgrabplus should store it's data files. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
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 any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
```text
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
To configure WebGrab+Plus follow the [guide][guideurl]
|
||||
To configure WebGrab+Plus follow the \[guide\]\[guideurl\]
|
||||
|
||||
Note that there are some things in the guide that does not apply to this container. Below you can find the changes.
|
||||
|
||||
**The configuration files are found where your config volume is mounted.**
|
||||
**Do not change the filename tag in the configuration file!**
|
||||
**The configuration files are found where your config volume is mounted.** **Do not change the filename tag in the configuration file!**
|
||||
|
||||
The /data volume mapping is where WebGrab+Plus outputs the xml file. To use the xml file in another program, you have to point it to the host path you mapped the /data volume to.
|
||||
|
||||
To adjust the scheduled cron job for grabbing, edit the wg-cron file found in the `/config` folder. After you have edited the the wg-cron file, restart the container to apply the new schedule.
|
||||
Do not adjust the command!
|
||||
To adjust the scheduled cron job for grabbing, edit the wg-cron file found in the `/config` folder. After you have edited the the wg-cron file, restart the container to apply the new schedule. Do not adjust the command!
|
||||
|
||||
Below is the syntax of the cron file.
|
||||
|
||||
```
|
||||
```text
|
||||
┌───────────── minute (0 - 59)
|
||||
│ ┌───────────── hour (0 - 23)
|
||||
│ │ ┌───────────── day of month (1 - 31)
|
||||
|
|
@ -133,8 +121,6 @@ Below is the syntax of the cron file.
|
|||
* * * * * s6-setuidgid abc /bin/bash /defaults/update.sh
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
|
|
@ -150,3 +136,4 @@ Below is the syntax of the cron file.
|
|||
|
||||
* **19.02.19:** - Add pipeline logic and multi arch.
|
||||
* **18.01.18:** - Initial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue