From 27d00d5f7c2f00f44aaee64be5a60227ce6e91d4 Mon Sep 17 00:00:00 2001 From: Josh Stark Date: Sat, 16 Mar 2019 13:24:50 +0000 Subject: [PATCH] GitBook: [master] 66 pages modified --- README.md | 2 +- SUMMARY.md | 3 +- general/fleet.md | 153 +++++++++++++++++++++++++++++ general/updating-our-containers.md | 1 + images/docker-airsonic.md | 46 ++++----- images/docker-bazarr.md | 51 ++++------ images/docker-beets.md | 44 +++------ images/docker-booksonic.md | 41 +++----- images/docker-bookstack.md | 62 +++++------- images/docker-cardigann.md | 51 ++++------ images/docker-codiad.md | 42 +++----- images/docker-cops.md | 71 ++++++------- images/docker-couchpotato.md | 48 ++++----- images/docker-daapd.md | 51 ++++------ images/docker-deluge.md | 56 +++++------ images/docker-diskover.md | 72 ++++++-------- images/docker-duckdns.md | 51 ++++------ images/docker-duplicati.md | 45 ++++----- images/docker-freshrss.md | 44 +++------ images/docker-gazee.md | 52 ++++------ images/docker-grocy.md | 48 ++++----- images/docker-headphones.md | 44 +++------ images/docker-heimdall.md | 54 ++++------ images/docker-htpcmanager.md | 41 +++----- images/docker-hydra.md | 42 +++----- images/docker-hydra2.md | 45 +++------ images/docker-jackett.md | 48 ++++----- images/docker-lazylibrarian.md | 47 ++++----- images/docker-ldap-auth.md | 43 +++----- images/docker-letsencrypt.md | 124 ++++++++++++----------- images/docker-libresonic.md | 44 +++------ images/docker-lidarr.md | 45 ++++----- images/docker-lychee.md | 46 ++++----- images/docker-mariadb.md | 61 +++++------- images/docker-medusa.md | 43 +++----- images/docker-minetest.md | 48 ++++----- images/docker-minisatip.md | 51 ++++------ images/docker-muximux.md | 45 +++------ images/docker-mylar.md | 47 ++++----- images/docker-nextcloud.md | 47 ++++----- images/docker-nginx.md | 46 ++++----- images/docker-nzbget.md | 47 ++++----- images/docker-ombi.md | 50 ++++------ images/docker-openvpnas.md | 100 ++++++++----------- images/docker-organizr.md | 52 ++++------ images/docker-photoshow.md | 42 +++----- images/docker-piwigo.md | 43 +++----- images/docker-plex.md | 90 ++++++++--------- images/docker-qbittorrent.md | 67 +++++-------- images/docker-quassel-core.md | 59 +++++------ images/docker-radarr.md | 45 +++------ images/docker-rutorrent.md | 54 ++++------ images/docker-shout-irc.md | 43 +++----- images/docker-sickgear.md | 60 ++++------- images/docker-smokeping.md | 56 +++++------ images/docker-snipe-it.md | 74 ++++++-------- images/docker-sonarr.md | 55 ++++------- images/docker-syncthing.md | 49 ++++----- images/docker-tautulli.md | 46 ++++----- images/docker-thelounge.md | 57 +++++------ images/docker-transmission.md | 44 +++------ images/docker-tt-rss.md | 62 +++++------- images/docker-tvheadend.md | 92 +++++++---------- images/docker-ubooquity.md | 47 ++++----- images/docker-znc.md | 47 ++++----- images/linuxserver-sabnzb.md | 2 + 66 files changed, 1414 insertions(+), 2014 deletions(-) create mode 100644 general/fleet.md mode change 100755 => 100644 images/docker-airsonic.md mode change 100755 => 100644 images/docker-bazarr.md mode change 100755 => 100644 images/docker-beets.md mode change 100755 => 100644 images/docker-booksonic.md mode change 100755 => 100644 images/docker-cardigann.md mode change 100755 => 100644 images/docker-codiad.md mode change 100755 => 100644 images/docker-cops.md mode change 100755 => 100644 images/docker-couchpotato.md mode change 100755 => 100644 images/docker-daapd.md mode change 100755 => 100644 images/docker-deluge.md mode change 100755 => 100644 images/docker-diskover.md mode change 100755 => 100644 images/docker-duckdns.md mode change 100755 => 100644 images/docker-duplicati.md mode change 100755 => 100644 images/docker-freshrss.md mode change 100755 => 100644 images/docker-gazee.md mode change 100755 => 100644 images/docker-grocy.md mode change 100755 => 100644 images/docker-heimdall.md mode change 100755 => 100644 images/docker-htpcmanager.md mode change 100755 => 100644 images/docker-hydra.md mode change 100755 => 100644 images/docker-hydra2.md mode change 100755 => 100644 images/docker-jackett.md mode change 100755 => 100644 images/docker-ldap-auth.md mode change 100755 => 100644 images/docker-letsencrypt.md mode change 100755 => 100644 images/docker-libresonic.md mode change 100755 => 100644 images/docker-lidarr.md mode change 100755 => 100644 images/docker-lychee.md mode change 100755 => 100644 images/docker-mariadb.md mode change 100755 => 100644 images/docker-medusa.md mode change 100755 => 100644 images/docker-minetest.md mode change 100755 => 100644 images/docker-muximux.md mode change 100755 => 100644 images/docker-nextcloud.md mode change 100755 => 100644 images/docker-nginx.md mode change 100755 => 100644 images/docker-nzbget.md mode change 100755 => 100644 images/docker-ombi.md mode change 100755 => 100644 images/docker-openvpnas.md mode change 100755 => 100644 images/docker-organizr.md mode change 100755 => 100644 images/docker-photoshow.md mode change 100755 => 100644 images/docker-piwigo.md mode change 100755 => 100644 images/docker-plex.md mode change 100755 => 100644 images/docker-qbittorrent.md mode change 100755 => 100644 images/docker-quassel-core.md mode change 100755 => 100644 images/docker-radarr.md mode change 100755 => 100644 images/docker-shout-irc.md mode change 100755 => 100644 images/docker-sickgear.md mode change 100755 => 100644 images/docker-smokeping.md mode change 100755 => 100644 images/docker-snipe-it.md mode change 100755 => 100644 images/docker-sonarr.md mode change 100755 => 100644 images/docker-tautulli.md mode change 100755 => 100644 images/docker-thelounge.md mode change 100755 => 100644 images/docker-transmission.md mode change 100755 => 100644 images/docker-tt-rss.md mode change 100755 => 100644 images/docker-tvheadend.md mode change 100755 => 100644 images/docker-ubooquity.md mode change 100755 => 100644 images/docker-znc.md create mode 100644 images/linuxserver-sabnzb.md diff --git a/README.md b/README.md index cf2c2b1f5..a8a0f5e45 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Welcome to the home of the LinuxServer.io documentation! It is our goal to ensure that all of our images are properly documented with all of the relevant information in order to help our users get started. As well as individual set up guides for each of our images, there is also general information pertaining to the running of Docker containers, and best practices. -### Want to get hold of the team? +## Want to get hold of the team? The team resides primarily in our Discord server. We also have a forum if chat isn't your thing. diff --git a/SUMMARY.md b/SUMMARY.md index 55e76db4e..fe97ad221 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -11,6 +11,7 @@ * [Understanding PUID and PGID](general/understanding-puid-and-pgid.md) * [Updating our containers](general/updating-our-containers.md) * [Volumes](general/volumes.md) +* [Fleet](general/fleet.md) ## Images @@ -62,7 +63,7 @@ * [linuxserver/quassel-core](images/docker-quassel-core.md) * [linuxserver/radarr](images/docker-radarr.md) * [linuxserver/rutorrent](images/docker-rutorrent.md) -* [linuxserver/sabnzb](images/docker-sabnzb.md) +* [linuxserver/sabnzb](images/linuxserver-sabnzb.md) * [linuxserver/shout-irc](images/docker-shout-irc.md) * [linuxserver/sickgear](images/docker-sickgear.md) * [linuxserver/smokeping](images/docker-smokeping.md) diff --git a/general/fleet.md b/general/fleet.md new file mode 100644 index 000000000..44da66e4e --- /dev/null +++ b/general/fleet.md @@ -0,0 +1,153 @@ +--- +description: >- + Fleet is a web-based image management tool for organisations who ship a large + list of Docker images. +--- + +# Fleet + +## How Fleet works + +Fleet stores a snapshot of Docker Images in its own database, consisting of metadata deemed most pertinent to both the users of the images, and the repository owner. It will synchronise with Docker Hub over a set interval in order to update its stored data. + +It then displays this snapshot data on its own status page as a useful list, containing links to each repository and image owned by the repository owner. Each image also contains a status which is managed by the repository owner, who can define images as either _Stable_ or _Unstable_. This is designed to quickly help users know when an image is undergoing a state of instability which is known by the owner. + +### Why a snapshot? + +In short, Docker Hub's API is very slow. It would not be a good long-term solution to just proxy the responses from Docker Hub and translate the data into something considered useful by downstream clients. By caching the image information in its own database, Fleet is able to more efficiently return the status data for each image and repository. In doing so, it is also able to provide more concise data, such as image versions, as part of the primary response, rather than requiring users to make a separate call. + +As an example comparison between obtaining all image name, pull and version information for all LinuxServer images from Docker Hub, and then obtaining that same data via Fleet's API: + +| API | Time \(ms\) | +| :--- | :--- | +| Docker Hub \(multiple calls\) | 52000ms | +| Fleet | 50ms | + +## API + +Fleet exposes a single API endpoint which can be used to obtain image list and pull count information for all relevant images maintained by the repository + +{% api-method method="get" host="https://fleet.base.url" path="/api/v1/images" %} +{% api-method-summary %} +Get All Repositories and Images +{% endapi-method-summary %} + +{% api-method-description %} +Returns all synchronised images. +{% endapi-method-description %} + +{% api-method-spec %} +{% api-method-request %} + +{% api-method-response %} +{% api-method-response-example httpCode=200 %} +{% api-method-response-example-description %} +All synchronised repositories and images returned. +{% endapi-method-response-example-description %} + +```javascript +{ + "status": "OK", + "data" { + "totalPullCount": 1862494227, + "repositories": { + "lsiobase": [ + { + "name": "alpine", + "pullCount": 4275970, + "version": "3.6", + "stable": true + }, + { + "name": "alpine.arm64", + "pullCount": 66234, + "version": "edge", + "stable": true + }, + ... + ], + "linuxserver": [ + { + "name": "airsonic", + "pullCount": 4608329, + "version": "v10.2.1", + "stable": true + }, + { + "name": "apache", + "pullCount": 3011699, + "version": "latest", + "stable": true + }, + ... + ] + ... + } + } +} +``` +{% endapi-method-response-example %} +{% endapi-method-response %} +{% endapi-method-spec %} +{% endapi-method %} + +{% hint style="info" %} +Any repositories not synchronised with Docker Hub \(e.g. staging or metadata repositories\) will not be returned as part of the API. This also applies to images which the repository owner does not wish to be part of the primary image list. +{% endhint %} + +## Running Fleet + +{% hint style="warning" %} +Fleet is a Java application, so requires at least JRE 1.8. +{% endhint %} + +Grab the latest Fleet release from [GitHub](https://github.com/linuxserver/fleet/releases). + +#### Configuration File + +All primary configuration for Fleet at runtime is loaded in via a `fleet.properties` file. This can be located anywhere on the file system, and is loaded in via a Runtime argument: + +```bash +# Runtime +fleet.app.port=8080 +fleet.refresh.interval=60 + +# User for management of images and repositories +fleet.admin.username= +fleet.admin.password= + +# Database Connectivity +fleet.database.driver=org.mariadb.jdbc.Driver +fleet.database.url=jdbc:mariadb://:3306/fleet +fleet.database.username= +fleet.database.password= + +# Docker Hub +fleet.dockerhub.username= +fleet.dockerhub.password= +``` + +| Property Name | Purpose | +| :--- | :--- | +| `fleet.app.port` | The port which the application will be running under. | +| `fleet.refresh.interval` | How often the application should synchronise with Docker Hub to update its list of known images. | +| `fleet.admin.username` | The username of the administrator who will be managing the application. | +| `fleet.admin.password` | A plain-text password for the administrator user. | +| `fleet.database.driver` | The driver to use for connections to Fleet's database. This should be `org.mariadb.jdbc.Driver` | +| `fleet.database.url` | The full JDBC connection string to the database. | +| `fleet.database.username` | The username of the SQL user which will be managing the data in the Fleet database. **This should have full GRANT access** to the fleet database as it also manages any database migrations. | +| `fleet.database.password` | The password for the SQL user | +| `fleet.dockerhub.username` | The username for the Docker Hub repository owner. | +| `fleet.dockerhub.password` | The password for the Docker Hub repository owner. | + +#### Runtime Configuration + +As well as the base configuration file, Fleet also supports some runtime arguments by means of the `-D` flag. These can be used to direct Fleet to behave in a specific way at runtime. + +| Runtime Argument | Purpose | +| :--- | :--- | +| `fleet.config.base` | The absolute path of the configuration file. | +| `fleet.show.passwords` | Tells fleet to show passwords in plain text in its logs. **Not recommended**. | +| `fleet.nuke.database` | **Be very careful.** This will tell Fleet to completely wipe and rebuild its database. This can be useful if the owner deems the database to be too far out of synchronisation with Docker Hub, or if images have since been removed but are still showing in Fleet. | +| `fleet.skip.sync.on.startup` | By default, Fleet will run a synchronisation process when it first starts up. Setting this flag will tell it to skip the first run. The next synchronisation will be at the set interval. | + diff --git a/general/updating-our-containers.md b/general/updating-our-containers.md index 2e63cc40e..36c2ce983 100644 --- a/general/updating-our-containers.md +++ b/general/updating-our-containers.md @@ -69,3 +69,4 @@ Whenever a Docker image is updated, a fresh version of that image gets downloade ```bash docker image prune ``` + diff --git a/images/docker-airsonic.md b/images/docker-airsonic.md old mode 100755 new mode 100644 index 69e25f4df..638477785 --- a/images/docker-airsonic.md +++ b/images/docker-airsonic.md @@ -1,37 +1,30 @@ -# [linuxserver/airsonic](https://github.com/linuxserver/docker-airsonic) +# linuxserver/airsonic -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/airsonic.svg)](https://microbadger.com/images/linuxserver/airsonic "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/airsonic.svg)](https://microbadger.com/images/linuxserver/airsonic "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/airsonic.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/airsonic.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-airsonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-airsonic/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/airsonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/airsonic/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/airsonic.svg)](https://microbadger.com/images/linuxserver/airsonic) [![](https://images.microbadger.com/badges/image/linuxserver/airsonic.svg)](https://microbadger.com/images/linuxserver/airsonic) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/airsonic.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/airsonic.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-airsonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-airsonic/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/airsonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/airsonic/latest/index.html) [Airsonic](https://github.com/airsonic/airsonic) is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. ## 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/). +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/). Simply pulling `linuxserver/airsonic` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=airsonic \ -e PUID=1000 \ @@ -49,7 +42,6 @@ docker create \ linuxserver/airsonic ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -81,46 +73,43 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `4040` | 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. | | `CONTEXT_PATH=` | For setting url-base in reverse proxy setups. | | `JAVA_OPTS=` | For passing additional java options. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Configuration file location. | | `/music` | Location of music. | | `/playlists` | Location for playlists to be saved to. | | `/podcasts` | Location of podcasts. | | `/media` | Location of other media. | - - ## 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) ``` @@ -131,9 +120,7 @@ Access WebUI at `:4040`. Default user/pass is admin/admin -Extra java options can be passed with the JAVA_OPTS environment variable, eg `-e JAVA_OPTS="-Xmx256m -Xms256m"` - - +Extra java options can be passed with the JAVA\_OPTS environment variable, eg `-e JAVA_OPTS="-Xmx256m -Xms256m"` ## Support Info @@ -152,5 +139,6 @@ Extra java options can be passed with the JAVA_OPTS environment variable, eg `-e * **05.01.19:** - Linting fixes. * **27.08.18:** - Use new inhouse java baseimage for quicker builds. * **23.08.18:** - Rebase to ubuntu bionic for increased performance across all arch's. -* **22.04.18:** - Add the forgotten JAVA_OPTS to the run command. +* **22.04.18:** - Add the forgotten JAVA\_OPTS to the run command. * **29.12.17:** - Initial Release. + diff --git a/images/docker-bazarr.md b/images/docker-bazarr.md old mode 100755 new mode 100644 index 004976d5d..6330d2fcb --- a/images/docker-bazarr.md +++ b/images/docker-bazarr.md @@ -1,37 +1,30 @@ -# [linuxserver/bazarr](https://github.com/linuxserver/docker-bazarr) +# linuxserver/bazarr -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/bazarr.svg)](https://microbadger.com/images/linuxserver/bazarr "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/bazarr.svg)](https://microbadger.com/images/linuxserver/bazarr "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bazarr.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bazarr.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-bazarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bazarr/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bazarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bazarr/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/bazarr.svg)](https://microbadger.com/images/linuxserver/bazarr) [![](https://images.microbadger.com/badges/image/linuxserver/bazarr.svg)](https://microbadger.com/images/linuxserver/bazarr) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bazarr.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bazarr.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-bazarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bazarr/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bazarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bazarr/latest/index.html) [Bazarr](https://github.com/morpheus65535/bazarr) is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you. ## 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/). +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/). Simply pulling `linuxserver/bazarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=bazarr \ -e PUID=1000 \ @@ -45,11 +38,7 @@ docker create \ linuxserver/bazarr ``` -You can choose between ,using tags, various branch versions of bazarr, no tag is required to remain on the main branch. -Add one of the tags, if required, to the linuxserver/bazarr line of the run/create command in the following format, linuxserver/bazarr:development -The development tag will be the latest commit in the development branch of bazarr. -HOWEVER , USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!! - +You can choose between ,using tags, various branch versions of bazarr, no tag is required to remain on the main branch. Add one of the tags, if required, to the linuxserver/bazarr line of the run/create command in the following format, linuxserver/bazarr:development The development tag will be the latest commit in the development branch of bazarr. HOWEVER , USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!! ### docker-compose @@ -77,52 +66,47 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `6767` | Allows HTTP access to the internal webserver. | - -### 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` | Bazarr data | | `/movies` | Location of your movies | | `/tv` | Location of your TV Shows | - - ## 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 -- Once running the URL will be `http://:6767`. -- You must complete all the setup parameters in the webui before you can save the config. - - +* Once running the URL will be `http://:6767`. +* You must complete all the setup parameters in the webui before you can save the config. ## Support Info @@ -139,3 +123,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **22.02.19:** - Rebasing to alpine 3.9. * **11.09.18:** - Initial release. + diff --git a/images/docker-beets.md b/images/docker-beets.md old mode 100755 new mode 100644 index 7958de5b3..3b5f430f6 --- a/images/docker-beets.md +++ b/images/docker-beets.md @@ -1,37 +1,30 @@ -# [linuxserver/beets](https://github.com/linuxserver/docker-beets) +# linuxserver/beets -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/beets.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/beets.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-beets/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-beets/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets) [![](https://images.microbadger.com/badges/image/linuxserver/beets.svg)](https://microbadger.com/images/linuxserver/beets) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/beets.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/beets.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-beets/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-beets/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/beets/latest/index.html) [Beets](http://beets.io/) is a music library manager and not, for the most part, a music player. It does include a simple player plugin and an experimental Web-based player, but it generally leaves actual sound-reproduction to specialized tools. ## 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/). +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/). Simply pulling `linuxserver/beets` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=beets \ -e PUID=1000 \ @@ -45,7 +38,6 @@ docker create \ linuxserver/beets ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -72,48 +64,43 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8337` | 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. | | `/music` | Music library | | `/downloads` | Non processed 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) ``` - - ## Support Info * Shell access whilst the container is running: @@ -133,7 +120,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **15.08.18:** - Rebase to alpine 3.8, use alpine repo version of pylast. * **12.08.18:** - Add requests pip package. * **04.03.18:** - Upgrade mp3gain to 1.6.1. -* **02.01.18:** - Deprecate cpu_core routine lack of scaling. +* **02.01.18:** - Deprecate cpu\_core routine lack of scaling. * **27.12.17:** - Add beautifulsoup4 pip package. * **06.12.17:** - Rebase to alpine linux 3.7. * **25.05.17:** - Rebase to alpine linux 3.6. @@ -149,3 +136,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **05.01.16:** - Change ffpmeg repository, other version crashes container * **06.11.15:** - Initial Release * **29.11.15:** - Take out term setting, causing issues with key entry for some users + diff --git a/images/docker-booksonic.md b/images/docker-booksonic.md old mode 100755 new mode 100644 index 1aaba3070..ddd4a88e6 --- a/images/docker-booksonic.md +++ b/images/docker-booksonic.md @@ -1,37 +1,30 @@ -# [linuxserver/booksonic](https://github.com/linuxserver/docker-booksonic) +# linuxserver/booksonic -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/booksonic.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/booksonic.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-booksonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-booksonic/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic) [![](https://images.microbadger.com/badges/image/linuxserver/booksonic.svg)](https://microbadger.com/images/linuxserver/booksonic) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/booksonic.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/booksonic.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-booksonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-booksonic/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/booksonic/latest/index.html) [Booksonic](http://booksonic.org) is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic. ## 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/). +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/). Simply pulling `linuxserver/booksonic` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=booksonic \ -e PUID=1000 \ @@ -47,7 +40,6 @@ docker create \ linuxserver/booksonic ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -76,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `4040` | 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. | | `CONTEXT_PATH=url-base` | Base url for use with reverse proxies etc. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Configuration files. | | `/audiobooks` | Audiobooks. | | `/podcasts` | Podcasts. | | `/othermedia` | Other media. | - - ## 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) ``` @@ -122,7 +111,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Default user/pass is admin/admin - ## Support Info * Shell access whilst the container is running: @@ -143,3 +131,4 @@ Default user/pass is admin/admin * **11.07.17:** - Rebase to alpine 3.6. * **07.02.17:** - Rebase to alpine 3.5. * **13.12.16:** - Initial Release. + diff --git a/images/docker-bookstack.md b/images/docker-bookstack.md index 5865e6023..664034f1e 100644 --- a/images/docker-bookstack.md +++ b/images/docker-bookstack.md @@ -1,42 +1,34 @@ -# [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack) +# linuxserver/bookstack -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/bookstack.svg)](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/bookstack.svg)](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bookstack.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bookstack.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-bookstack/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/bookstack.svg)](https://microbadger.com/images/linuxserver/bookstack) [![](https://images.microbadger.com/badges/image/linuxserver/bookstack.svg)](https://microbadger.com/images/linuxserver/bookstack) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bookstack.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bookstack.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-bookstack/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/index.html) [Bookstack](https://github.com/BookStackApp/BookStack) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease. Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore. -For more information on BookStack visit their website and check it out: https://www.bookstackapp.com - +For more information on BookStack visit their website and check it out: [https://www.bookstackapp.com](https://www.bookstackapp.com) ## 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/). +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/). Simply pulling `linuxserver/bookstack` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=bookstack \ -e PUID=1000 \ @@ -52,7 +44,6 @@ docker create \ linuxserver/bookstack ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -81,44 +72,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 `:` 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 `:` 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` | will map the container's port 80 to port 6875 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 | | `DB_HOST=` | for specifying the database host | | `DB_USER=` | for specifying the database user | | `DB_PASS=` | for specifying the database password | | `DB_DATABASE=bookstackapp` | for specifying the database to be used | -| `APP_URL=your.site.here.xyz` | for specifying the url your application will be accessed on (required for correct operation of reverse proxy) | +| `APP_URL=your.site.here.xyz` | for specifying the url your application will be accessed on \(required for correct operation of reverse proxy\) | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | this will store any uploaded data on the docker host | - - ## 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) ``` @@ -131,7 +119,7 @@ Once the MariaDB container is deployed, you can enter the following commands int **Note** this will allow any user with these credentials to connect to the server, it is not limited to localhost -``` +```text from shell on sql container: mysql -u root -p CREATE DATABASE bookstackapp; @@ -140,26 +128,25 @@ GRANT ALL privileges ON `bookstackapp`.* TO 'myuser'@'%'; FLUSH PRIVILEGES; ``` -Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as with the correct data. +Once you have completed these, you can then use the docker run command to create your BookStack container. Make sure you replace things such as with the correct data. -Then docker start bookstackapp to start the container. You should then be able to access the container at http://dockerhost:6875 +Then docker start bookstackapp to start the container. You should then be able to access the container at [http://dockerhost:6875](http://dockerhost:6875) Default username is admin@admin.com with password of **password** If you intend to use this application behind a reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work -Documentation for BookStack can be found at https://www.bookstackapp.com/docs/ +Documentation for BookStack can be found at [https://www.bookstackapp.com/docs/](https://www.bookstackapp.com/docs/) + +### Advanced Users \(full control over the .env file\) -### Advanced Users (full control over the .env file) If you wish to use the extra functionality of BookStack such as email, memcache, ldap and so on you will need to make your own .env file with guidance from the BookStack documentation. -When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. +When you create the container, do not set any arguments for any SQL settings, or APP\_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. ### Composer -Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you. - - +Some simple docker-compose files are included for you to get started with. You will still need to manually configure the SQL server, but the compose files will get the stack running for you. ## Support Info @@ -180,3 +167,4 @@ Some simple docker-compose files are included for you to get started with. You w * **08.10.18:** - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files * **23.09.28:** - Updates pre-release * **02.07.18:** - Initial Release. + diff --git a/images/docker-cardigann.md b/images/docker-cardigann.md old mode 100755 new mode 100644 index 6c34da245..8072cc3b3 --- a/images/docker-cardigann.md +++ b/images/docker-cardigann.md @@ -1,38 +1,30 @@ -# [linuxserver/cardigann](https://github.com/linuxserver/docker-cardigann) +# linuxserver/cardigann -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cardigann.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cardigann.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-cardigann/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cardigann/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann) [![](https://images.microbadger.com/badges/image/linuxserver/cardigann.svg)](https://microbadger.com/images/linuxserver/cardigann) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cardigann.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cardigann.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-cardigann/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cardigann/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cardigann/latest/index.html) [Cardigann](https://github.com/cardigann/cardigann) a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format. - ## 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/). +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/). Simply pulling `linuxserver/cardigann` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=cardigann \ -e PUID=1000 \ @@ -45,7 +37,6 @@ docker create \ linuxserver/cardigann ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -71,41 +62,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `5060` | The port for the Cardigann 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 | -| `SOCKS_PROXY=IP:PORT` | for using a socks proxy (optional) | -| `HTTP_PROXY=IP:PORT` | for using a HTTP proxy (optional) | +| `SOCKS_PROXY=IP:PORT` | for using a socks proxy \(optional\) | +| `HTTP_PROXY=IP:PORT` | for using a HTTP proxy \(optional\) | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Cardigann config | - - ## 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) ``` @@ -114,11 +102,9 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:5060`, for more information check out [Cardigann](https://github.com/cardigann/cardigann). -By adding a variable to the run command, `SOCKS_PROXY` or `HTTP_PROXY` cardigann can be used with a proxy, *eg* `-e SOCKS_PROXY=localhost:1080` - -The folder `/config/definitions` can be used to add additional tracker definitions (for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions) ). - +By adding a variable to the run command, `SOCKS_PROXY` or `HTTP_PROXY` cardigann can be used with a proxy, _eg_ `-e SOCKS_PROXY=localhost:1080` +The folder `/config/definitions` can be used to add additional tracker definitions \(for more info see [Additional definitions](https://github.com/cardigann/cardigann#definitions) \). ## Support Info @@ -143,3 +129,4 @@ The folder `/config/definitions` can be used to add additional tracker definitio * **07.02.17:** - Rebase to alpine 3.5 * **03.11.16:** - Compiled using [sstamoulis'](https://github.com/sstamoulis) method * **01.11.16:** - Initial Release + diff --git a/images/docker-codiad.md b/images/docker-codiad.md old mode 100755 new mode 100644 index 9fa4ddf58..6b936241d --- a/images/docker-codiad.md +++ b/images/docker-codiad.md @@ -1,37 +1,30 @@ -# [linuxserver/codiad](https://github.com/linuxserver/docker-codiad) +# linuxserver/codiad -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/codiad.svg)](https://microbadger.com/images/linuxserver/codiad "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/codiad.svg)](https://microbadger.com/images/linuxserver/codiad "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/codiad.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/codiad.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-codiad/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codiad/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codiad/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codiad/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/codiad.svg)](https://microbadger.com/images/linuxserver/codiad) [![](https://images.microbadger.com/badges/image/linuxserver/codiad.svg)](https://microbadger.com/images/linuxserver/codiad) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/codiad.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/codiad.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-codiad/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codiad/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codiad/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codiad/latest/index.html) [Codiad](http://codiad.com/) is a web-based IDE framework with a small footprint and minimal requirements. We have added a few plugins. More can be added in the marketplace in the WebUI. ## 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/). +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/). Simply pulling `linuxserver/codiad` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=codiad \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/codiad ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,46 +60,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 `:` 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 `:` 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. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where Codiad stores 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) ``` - - ## Support Info * Shell access whilst the container is running: @@ -131,3 +118,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **14.10.16:** - Add version layer information. * **10.09.16:** - Add layer badges to README. * **06.11.15:** - Initial Release. + diff --git a/images/docker-cops.md b/images/docker-cops.md old mode 100755 new mode 100644 index 9a541fd2c..19affa846 --- a/images/docker-cops.md +++ b/images/docker-cops.md @@ -1,14 +1,8 @@ -# [linuxserver/cops](https://github.com/linuxserver/docker-cops) +# linuxserver/cops -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cops.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cops.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-cops/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cops/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cops/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cops/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops) [![](https://images.microbadger.com/badges/image/linuxserver/cops.svg)](https://microbadger.com/images/linuxserver/cops) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cops.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cops.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-cops/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cops/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cops/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/cops/latest/index.html) -[Cops](http://blog.slucas.fr/en/oss/calibre-opds-php-server) by Sébastien Lucas, stands for Calibre OPDS (and HTML) Php Server. +[Cops](http://blog.slucas.fr/en/oss/calibre-opds-php-server) by Sébastien Lucas, stands for Calibre OPDS \(and HTML\) Php Server. COPS links to your Calibre library database and allows downloading and emailing of books directly from a web browser and provides a OPDS feed to connect to your devices. @@ -18,52 +12,48 @@ See : [COPS's home](http://blog.slucas.fr/en/oss/calibre-opds-php-server) for mo Don't forget to check the [Wiki](https://github.com/seblucas/cops/wiki). -## Why? (taken from the author's site) +## Why? \(taken from the author's site\) -In my opinion Calibre is a marvelous tool but is too big and has too much -dependencies to be used for its content server. +In my opinion Calibre is a marvelous tool but is too big and has too much dependencies to be used for its content server. -That's the main reason why I coded this OPDS server. I needed a simple -tool to be installed on a small server (Seagate Dockstar in my case). +That's the main reason why I coded this OPDS server. I needed a simple tool to be installed on a small server \(Seagate Dockstar in my case\). -I initially thought of Calibre2OPDS but as it generate static file no -search was possible. +I initially thought of Calibre2OPDS but as it generate static file no search was possible. Later I added an simple HTML catalog that should be usable on my Kobo. So COPS's main advantages are : - * No need for many dependencies. - * No need for a lot of CPU or RAM. - * Not much code. - * Search is available. - * With Dropbox / owncloud it's very easy to have an up to date OPDS server. - * It was fun to code. + +* No need for many dependencies. +* No need for a lot of CPU or RAM. +* Not much code. +* Search is available. +* With Dropbox / owncloud it's very easy to have an up to date OPDS server. +* It was fun to code. If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL. - ## 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/). +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/). Simply pulling `linuxserver/cops` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=cops \ -e PUID=1000 \ @@ -76,7 +66,6 @@ docker create \ linuxserver/cops ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -102,50 +91,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 `:` 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 `:` 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. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | COPS Application Data. | | `/books` | Calibre metadata.db 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) ``` ## Application Setup -Unlike other implementations of COPS in a docker container, the linuxserver version gives you access to `config_local.php` in `/config` to customise your install to suit your needs, including details of your email account etc to enable emailing of books, it also includes the dependencies required to directly view epub books in your browser. - - +Unlike other implementations of COPS in a docker container, the linuxserver version gives you access to `config_local.php` in `/config` to customise your install to suit your needs, including details of your email account etc to enable emailing of books, it also includes the dependencies required to directly view epub books in your browser. ## Support Info @@ -178,3 +162,4 @@ Unlike other implementations of COPS in a docker container, the linuxserver ver * **29.08.16:** - Add php5-opcache. * **28.08.16:** - Add badges to README. * **12.08.16:** - Initial Release. + diff --git a/images/docker-couchpotato.md b/images/docker-couchpotato.md old mode 100755 new mode 100644 index dcf2a29bd..dfed761b7 --- a/images/docker-couchpotato.md +++ b/images/docker-couchpotato.md @@ -1,37 +1,30 @@ -# [linuxserver/couchpotato](https://github.com/linuxserver/docker-couchpotato) +# linuxserver/couchpotato -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/couchpotato.svg)](https://microbadger.com/images/linuxserver/couchpotato "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/couchpotato.svg)](https://microbadger.com/images/linuxserver/couchpotato "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/couchpotato.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/couchpotato.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-couchpotato/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-couchpotato/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/couchpotato/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/couchpotato/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/couchpotato.svg)](https://microbadger.com/images/linuxserver/couchpotato) [![](https://images.microbadger.com/badges/image/linuxserver/couchpotato.svg)](https://microbadger.com/images/linuxserver/couchpotato) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/couchpotato.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/couchpotato.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-couchpotato/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-couchpotato/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/couchpotato/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/couchpotato/latest/index.html) [Couchpotato](https://couchpota.to/) is an automatic NZB and torrent downloader. You can keep a `movies I want` list and it will search for NZBs/torrents of these movies every X hours. Once a movie is found, it will send it to SABnzbd or download the torrent to a specified directory. ## 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/). +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/). Simply pulling `linuxserver/couchpotato` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=couchpotato \ -e PUID=1000 \ @@ -46,7 +39,6 @@ docker create \ linuxserver/couchpotato ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -74,43 +66,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `5050` | http gui | - -### 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 | | `UMASK_SET=022` | for umask setting of couchpotato, optional , default if left unset is 022 | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Couchpotato Application Data. | | `/downloads` | Downloads Folder. | | `/movies` | Movie 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) ``` @@ -119,8 +108,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:5050`, for more information check out [CouchPotato](https://couchpota.to). - - ## Support Info * Shell access whilst the container is running: @@ -138,15 +125,16 @@ Access the webui at `:5050`, for more information check out [CouchPotat * **14.01.19:** - Multi-arch builds. * **16.08.18:** - Rebase to alpine 3.8. * **06.11.17:** - Rebase to alpine 3.7. -* **20.07.17:** - Internal git pull instead of at runtime, add UMASK_SET variable. +* **20.07.17:** - Internal git pull instead of at runtime, add UMASK\_SET variable. * **12.07.17:** - Add inspect commands to README, move to jenkins build and push * **25.05.17:** - Rebase to alpine 3.6 * **07.02.17:** - Rebase to alpine 3.5. -* **11.11.16:** - Stop cp logging to docker log (they are accessible in the webui and the config folder). +* **11.11.16:** - Stop cp logging to docker log \(they are accessible in the webui and the config folder\). * **30.09.16:** - Fix umask. * **09.09.16:** - Add layer badges to README. * **27.08.16:** - Add badges to README. * **08.08.16:** - Rebase to alpine linux. * **12.11.15:** - Misc Code Cleanup. * **02.10.15:** - Change to python baseimage. -* **28.07.15:** - Updated to latest baseimage (for testing), and a fix to autoupdate. +* **28.07.15:** - Updated to latest baseimage \(for testing\), and a fix to autoupdate. + diff --git a/images/docker-daapd.md b/images/docker-daapd.md old mode 100755 new mode 100644 index 2699d7ff7..8ff50d0d3 --- a/images/docker-daapd.md +++ b/images/docker-daapd.md @@ -1,37 +1,30 @@ -# [linuxserver/daapd](https://github.com/linuxserver/docker-daapd) +# linuxserver/daapd -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/daapd.svg)](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/daapd.svg)](https://microbadger.com/images/linuxserver/daapd "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/daapd.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/daapd.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-daapd/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-daapd/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/daapd.svg)](https://microbadger.com/images/linuxserver/daapd) [![](https://images.microbadger.com/badges/image/linuxserver/daapd.svg)](https://microbadger.com/images/linuxserver/daapd) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/daapd.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/daapd.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-daapd/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-daapd/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/daapd/latest/index.html) -[Daapd](https://ejurgensen.github.io/forked-daapd/) (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio. +[Daapd](https://ejurgensen.github.io/forked-daapd/) \(iTunes\) media server with support for AirPlay devices, Apple Remote \(and compatibles\), Chromecast, MPD and internet radio. ## 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/). +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/). Simply pulling `linuxserver/daapd` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=daapd \ --net=host \ @@ -44,7 +37,6 @@ docker create \ linuxserver/daapd ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -69,44 +61,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | + + +#### Networking \(`--net`\) -#### Networking (`--net`) | Parameter | Function | -| :-----: | --- | +| :---: | :--- | | `--net=host` | Shares host networking with container. | -### 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 daapd server stores its config and dbase files. | | `/music` | Map to your music folder. | - - ## 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) ``` @@ -119,8 +111,6 @@ The web interface is available at `http://:3689` For further setup options of remotes etc, check out the daapd website, [Forked-daapd](https://ejurgensen.github.io/forked-daapd/). - - ## Support Info * Shell access whilst the container is running: @@ -139,7 +129,7 @@ For further setup options of remotes etc, check out the daapd website, [Forked-d * **09.06.18:** - Use buildstage and update dependencies. * **05.03.18:** - Use updated configure ac and disable avcodecsend to hopefully mitigate crashes with V26. * **25.02.18:** - Query version before pull and build latest release. -* **03.01.18:** - Deprecate cpu_core routine lack of scaling. +* **03.01.18:** - Deprecate cpu\_core routine lack of scaling. * **07.12.17:** - Rebase to alpine linux 3.7. * **03.12.17:** - Bump to 25.0, cpu core counting routine for faster builds, linting fixes. * **26.05.17:** - Rebase to alpine linux 3.6. @@ -151,3 +141,4 @@ For further setup options of remotes etc, check out the daapd website, [Forked-d * **04.01.16:** - Disable ipv6 by default because in v23.4 it doesn't work in unraid with it set. * **17.12.15:** - Add in spotify support. * **25.11.15:** - Initial Release. + diff --git a/images/docker-deluge.md b/images/docker-deluge.md old mode 100755 new mode 100644 index 7e041d4eb..e329ba606 --- a/images/docker-deluge.md +++ b/images/docker-deluge.md @@ -1,12 +1,6 @@ -# [linuxserver/deluge](https://github.com/linuxserver/docker-deluge) +# linuxserver/deluge -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/deluge.svg)](https://microbadger.com/images/linuxserver/deluge "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/deluge.svg)](https://microbadger.com/images/linuxserver/deluge "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/deluge.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/deluge.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-deluge/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-deluge/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/deluge/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/deluge/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/deluge.svg)](https://microbadger.com/images/linuxserver/deluge) [![](https://images.microbadger.com/badges/image/linuxserver/deluge.svg)](https://microbadger.com/images/linuxserver/deluge) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/deluge.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/deluge.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-deluge/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-deluge/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/deluge/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/deluge/latest/index.html) [Deluge](http://deluge-torrent.org/) is a lightweight, Free Software, cross-platform BitTorrent client. @@ -15,29 +9,27 @@ * Plugin System * Much more... - ## 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/). +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/). Simply pulling `linuxserver/deluge` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=deluge \ --net=host \ @@ -51,7 +43,6 @@ docker create \ linuxserver/deluge ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -77,58 +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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | + + +#### Networking \(`--net`\) -#### Networking (`--net`) | Parameter | Function | -| :-----: | --- | +| :---: | :--- | | `--net=host` | Shares host networking with container, **required**. | -### Environment Variables (`-e`) +### Environment Variables \(`-e`\) | Env | Function | -| :----: | --- | +| :---: | :--- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `UMASK_SET=<022>` | for umask setting of deluge, *optional* , default if left unset is 022. | +| `UMASK_SET=<022>` | for umask setting of deluge, _optional_ , default if left unset is 022. | | `TZ=` | Specify a timezone to use EG Europe/London | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | deluge configs | | `/downloads` | torrent download 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) ``` ## Application Setup -The admin interface is available at http://:8112 with a default user/password of admin/deluge. - -To change the password (recommended) log in to the web interface and go to Preferences->Interface->Password. - -Change the downloads location in the webui in Preferences->Downloads and use /downloads for completed downloads. +The admin interface is available at http://:8112 with a default user/password of admin/deluge. +To change the password \(recommended\) log in to the web interface and go to Preferences->Interface->Password. +Change the downloads location in the webui in Preferences->Downloads and use /downloads for completed downloads. ## Support Info @@ -163,3 +152,4 @@ Change the downloads location in the webui in Preferences->Downloads and use /do * **15.08.16:** - Rebase to alpine linux. * **09.11.15:** - Add unrar and unzip * **15.10.15:** - Initial Release. + diff --git a/images/docker-diskover.md b/images/docker-diskover.md old mode 100755 new mode 100644 index 50dd7df73..1b477e2c4 --- a/images/docker-diskover.md +++ b/images/docker-diskover.md @@ -1,37 +1,30 @@ -# [linuxserver/diskover](https://github.com/linuxserver/docker-diskover) +# linuxserver/diskover -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/diskover.svg)](https://microbadger.com/images/linuxserver/diskover "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/diskover.svg)](https://microbadger.com/images/linuxserver/diskover "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/diskover.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/diskover.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-diskover/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-diskover/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/diskover/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/diskover/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/diskover.svg)](https://microbadger.com/images/linuxserver/diskover) [![](https://images.microbadger.com/badges/image/linuxserver/diskover.svg)](https://microbadger.com/images/linuxserver/diskover) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/diskover.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/diskover.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-diskover/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-diskover/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/diskover/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/diskover/latest/index.html) [diskover](https://github.com/shirosaidev/diskover) is a file system crawler and disk space usage software that uses Elasticsearch to index and manage data across heterogeneous storage systems. ## 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/). +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/). Simply pulling `linuxserver/diskover` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=diskover \ -e PUID=1000 \ @@ -57,7 +50,6 @@ docker create \ linuxserver/diskover ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -109,70 +101,65 @@ services: image: redis:alpine volumes: - ${HOME}/docker/redis:/data - ``` ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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` | diskover Web UI | | `9181` | rq-dashboard web UI | | `9999` | diskover socket server | - -### 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 | -| `REDIS_HOST=redis` | Redis host (optional) | -| `REDIS_PORT=6379` | Redis port (optional) | -| `ES_HOST=elasticsearch` | ElasticSearch host (optional) | -| `ES_PORT=9200` | ElasticSearch port (optional) | -| `ES_USER=elastic` | ElasticSearch username (optional) | -| `ES_PASS=changeme` | ElasticSearch password (optional) | -| `INDEX_NAME=diskover-` | Index name prefix (optional) | -| `DISKOVER_OPTS=` | Optional arguments to pass to the diskover crawler (optional) | -| `WORKER_OPTS=` | Optional argumens to pass to the diskover bots launcher (optional) | -| `RUN_ON_START=true` | Initiate a crawl every time the container is started (optional) | -| `USE_CRON=true` | Run a crawl on as a cron job (optional) | +| `REDIS_HOST=redis` | Redis host \(optional\) | +| `REDIS_PORT=6379` | Redis port \(optional\) | +| `ES_HOST=elasticsearch` | ElasticSearch host \(optional\) | +| `ES_PORT=9200` | ElasticSearch port \(optional\) | +| `ES_USER=elastic` | ElasticSearch username \(optional\) | +| `ES_PASS=changeme` | ElasticSearch password \(optional\) | +| `INDEX_NAME=diskover-` | Index name prefix \(optional\) | +| `DISKOVER_OPTS=` | Optional arguments to pass to the diskover crawler \(optional\) | +| `WORKER_OPTS=` | Optional argumens to pass to the diskover bots launcher \(optional\) | +| `RUN_ON_START=true` | Initiate a crawl every time the container is started \(optional\) | +| `USE_CRON=true` | Run a crawl on as a cron job \(optional\) | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Persistent config files | | `/data` | Default mount point to crawl | - - ## 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 -Once running the URL will be `http:///` initial application spinup will take some time so please reload if you get an empty response. We highly reccomend using Docker compose for this image as it includes multiple database backends to link into. -If you are looking to mount the elasticsearch and redis data to your host machine for access neither of them currently support setting a custom UID or GID they will run by default as: +Once running the URL will be `http:///` initial application spinup will take some time so please reload if you get an empty response. We highly reccomend using Docker compose for this image as it includes multiple database backends to link into. If you are looking to mount the elasticsearch and redis data to your host machine for access neither of them currently support setting a custom UID or GID they will run by default as: -- Redis - UID=999 GID=999 -- Elasticsearch - UID=1000 GID=1000 +* Redis - UID=999 GID=999 +* Elasticsearch - UID=1000 GID=1000 ElasticSearch also requires a sysctl setting on the host machine to run properly. Running `sysctl -w vm.max_map_count=262144` will solve this issue. To make this setting persistent through reboots, set this value in `/etc/sysctl.conf`. @@ -182,8 +169,6 @@ By default this compose example is pointed to a single directory and the UID and For specific questions or help setting up diskover in your environment please refer to the project's Github page [Diskover](https://github.com/shirosaidev/diskover). - - ## Support Info * Shell access whilst the container is running: @@ -198,3 +183,4 @@ For specific questions or help setting up diskover in your environment please re ## Versions * **01.11.18:** - Initial Release. + diff --git a/images/docker-duckdns.md b/images/docker-duckdns.md old mode 100755 new mode 100644 index 91a22195e..b67945e03 --- a/images/docker-duckdns.md +++ b/images/docker-duckdns.md @@ -1,37 +1,30 @@ -# [linuxserver/duckdns](https://github.com/linuxserver/docker-duckdns) +# linuxserver/duckdns -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/duckdns.svg)](https://microbadger.com/images/linuxserver/duckdns "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/duckdns.svg)](https://microbadger.com/images/linuxserver/duckdns "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duckdns.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duckdns.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-duckdns/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-duckdns/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/duckdns.svg)](https://microbadger.com/images/linuxserver/duckdns) [![](https://images.microbadger.com/badges/image/linuxserver/duckdns.svg)](https://microbadger.com/images/linuxserver/duckdns) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duckdns.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duckdns.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-duckdns/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-duckdns/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duckdns/latest/index.html) -[Duckdns](https://duckdns.org/) is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence. +[Duckdns](https://duckdns.org/) is a free service which will point a DNS \(sub domains of duckdns.org\) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence. ## 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/). +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/). Simply pulling `linuxserver/duckdns` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=duckdns \ -e PUID=1000 `#optional` \ @@ -45,7 +38,6 @@ docker create \ linuxserver/duckdns ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -72,53 +64,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 `:` 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 `:` 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 | | `SUBDOMAINS=subdomain1,subdomain2` | multiple subdomains allowed, comma separated, no spaces | | `TOKEN=token` | DuckDNS token | -| `LOG_FILE=false` | Set to `true` to log to file (also need to map /config). | +| `LOG_FILE=false` | Set to `true` to log to file \(also need to map /config\). | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Used in conjunction with logging to file. | - - ## 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 -- Go to the [duckdns website](https://duckdns.org/), register your subdomain(s) and retrieve your token -- Create a container with your subdomain(s) and token -- It will update your IP with the DuckDNS service every 5 minutes - - +* Go to the [duckdns website](https://duckdns.org/), register your subdomain\(s\) and retrieve your token +* Create a container with your subdomain\(s\) and token +* It will update your IP with the DuckDNS service every 5 minutes ## Support Info @@ -142,3 +130,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **28.05.17:** - Rebase to alpine 3.6. * **09.02.17:** - Rebase to alpine 3.5. * **17.11.16:** - Initial release. + diff --git a/images/docker-duplicati.md b/images/docker-duplicati.md old mode 100755 new mode 100644 index 8f1fefd19..7878d1d4b --- a/images/docker-duplicati.md +++ b/images/docker-duplicati.md @@ -1,25 +1,19 @@ -# [linuxserver/duplicati](https://github.com/linuxserver/docker-duplicati) +# linuxserver/duplicati -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duplicati.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duplicati.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-duplicati/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-duplicati/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duplicati/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duplicati/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati) [![](https://images.microbadger.com/badges/image/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duplicati.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duplicati.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-duplicati/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-duplicati/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duplicati/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/duplicati/latest/index.html) [Duplicati](https://www.duplicati.com/) works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others. ## 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/). +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/). Simply pulling `linuxserver/duplicati` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 | Beta releases of Duplicati | | development | Canary releases of Duplicati | @@ -39,7 +33,7 @@ Here are some example snippets to help you get started creating a container from ### docker -``` +```text docker create \ --name=duplicati \ -e PUID=1000 \ @@ -53,7 +47,6 @@ docker create \ linuxserver/duplicati ``` - ### 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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8200` | http gui | - -### 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` | Contains all relevant configuration files. | | `/backups` | Path to store local backups. | | `/source` | Path to source for files to backup. | - - ## 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 The webui is at `:8200` , create backup jobs etc via the webui, for local backups select `/backups` as the destination. For more information see [Duplicati](https://www.duplicati.com/). - - ## Support Info * Shell access whilst the container is running: @@ -143,5 +131,6 @@ The webui is at `:8200` , create backup jobs etc via the webui, for loc * **13.01.19:** - Use jq instead of awk in dockerfiles. * **11.01.19:** - Multi-arch image. * **09.12.17:** - Fix continuation lines. -* **31.08.17:** - Build only beta or release versions (thanks deasmi). +* **31.08.17:** - Build only beta or release versions \(thanks deasmi\). * **24.04.17:** - Initial release. + diff --git a/images/docker-freshrss.md b/images/docker-freshrss.md old mode 100755 new mode 100644 index 3a7c7497f..6350b17e6 --- a/images/docker-freshrss.md +++ b/images/docker-freshrss.md @@ -1,37 +1,30 @@ -# [linuxserver/freshrss](https://github.com/linuxserver/docker-freshrss) +# linuxserver/freshrss -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/freshrss.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-freshrss/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-freshrss/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/freshrss/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/freshrss/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss) [![](https://images.microbadger.com/badges/image/linuxserver/freshrss.svg)](https://microbadger.com/images/linuxserver/freshrss) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/freshrss.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/freshrss.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-freshrss/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-freshrss/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/freshrss/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/freshrss/latest/index.html) [Freshrss](https://freshrss.org/) is a free, self-hostable aggregator for rss feeds. ## 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/). +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/). Simply pulling `linuxserver/freshrss` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=freshrss \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/freshrss ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,49 +60,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Local storage for freshrss site 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 -Create a user and database in your mysql/mariadb server (not root) and then follow the setup wizard in the webui. Use the IP address for "host" of your database server. - - +Create a user and database in your mysql/mariadb server \(not root\) and then follow the setup wizard in the webui. Use the IP address for "host" of your database server. ## Support Info @@ -138,3 +125,4 @@ Create a user and database in your mysql/mariadb server (not root) and then foll * **11.09.16:** - Add layer badges to README. * **23.11.15:** - Update dependencies to latest requirements. * **21.08.15:** - Initial Release. + diff --git a/images/docker-gazee.md b/images/docker-gazee.md old mode 100755 new mode 100644 index 892576a79..5d5c22c14 --- a/images/docker-gazee.md +++ b/images/docker-gazee.md @@ -1,37 +1,30 @@ -# [linuxserver/gazee](https://github.com/linuxserver/docker-gazee) +# linuxserver/gazee -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/gazee.svg)](https://microbadger.com/images/linuxserver/gazee "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/gazee.svg)](https://microbadger.com/images/linuxserver/gazee "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/gazee.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/gazee.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-gazee/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-gazee/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/gazee/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/gazee/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/gazee.svg)](https://microbadger.com/images/linuxserver/gazee) [![](https://images.microbadger.com/badges/image/linuxserver/gazee.svg)](https://microbadger.com/images/linuxserver/gazee) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/gazee.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/gazee.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-gazee/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-gazee/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/gazee/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/gazee/latest/index.html) [Gazee](https://github.com/hubbcaps/gazee) is a WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser. ## 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/). +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/). Simply pulling `linuxserver/gazee` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=gazee \ -e PUID=1000 \ @@ -45,7 +38,6 @@ docker create \ linuxserver/gazee ``` - ### 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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `4242` | 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 | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where Gazee should store config files. | | `/comics` | Path to comics folder. | | `/mylar` | Path to Mylar DB. | | `/certs` | Where SSL certs should be stored. | - - ## 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,10 +105,10 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Webui can be found at `your-ip:4242` - Default username and password for the web interface: +Default username and password for the web interface: - * **Username:** `admin` - * **Password:** `gazee` +* **Username:** `admin` +* **Password:** `gazee` Click the gear icon to go to the settings page. @@ -127,16 +116,14 @@ Change the default admin password or add a new admin and remove the admin user a Comic path should be set to `/comics` -*Optional* Mylar DB path should be set to `/mylar` +_Optional_ Mylar DB path should be set to `/mylar` -*Optional* path for certificates and keys should be set to `/certs` +_Optional_ path for certificates and keys should be set to `/certs` After you update the settings, Gazee will restart and begin an intial scan of your comic library. Happy Reading! - - ## Support Info * Shell access whilst the container is running: @@ -154,3 +141,4 @@ Happy Reading! * **17.08.18:** - Rebase to alpine 3.8. * **30.12.17:** - Ensure version 11 of cherrypy. * **07.12.17:** - Initial Release. + diff --git a/images/docker-grocy.md b/images/docker-grocy.md old mode 100755 new mode 100644 index c84ec46bd..8c0a14cdd --- a/images/docker-grocy.md +++ b/images/docker-grocy.md @@ -1,42 +1,34 @@ -# [linuxserver/grocy](https://github.com/linuxserver/docker-grocy) +# linuxserver/grocy -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/grocy.svg)](https://microbadger.com/images/linuxserver/grocy "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/grocy.svg)](https://microbadger.com/images/linuxserver/grocy "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/grocy.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/grocy.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-grocy/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-grocy/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/grocy/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/grocy/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/grocy.svg)](https://microbadger.com/images/linuxserver/grocy) [![](https://images.microbadger.com/badges/image/linuxserver/grocy.svg)](https://microbadger.com/images/linuxserver/grocy) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/grocy.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/grocy.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-grocy/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-grocy/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/grocy/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/grocy/latest/index.html) [Grocy](https://github.com/grocy/grocy) is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utulity. Keep track of your purchaes, how much food you are wasting, what chores need doing and what batteries need charging with this proudly Open Source tool -For more information on grocy visit their website and check it out: https://grocy.info - +For more information on grocy visit their website and check it out: [https://grocy.info](https://grocy.info) ## 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/). +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/). Simply pulling `linuxserver/grocy` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=grocy \ -e PUID=1000 \ @@ -48,7 +40,6 @@ docker create \ linuxserver/grocy ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -73,50 +64,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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` | will map the container's port 80 to port 9283 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 | | `TZ=` | for specifying your timezone | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | this will store any uploaded data on the docker host | - - ## 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 -Grocy is simple to get running. Configure the container with the above instructions, start it, and you can then access it -by visiting http://your.ip:9283 - once the page loads, you can log in with the default username and password of admin / admin - - +Grocy is simple to get running. Configure the container with the above instructions, start it, and you can then access it by visiting [http://your.ip:9283](http://your.ip:9283) - once the page loads, you can log in with the default username and password of admin / admin ## Support Info @@ -133,3 +118,4 @@ by visiting http://your.ip:9283 - once the page loads, you can log in with the d * **22.02.19:** - Rebasing to alpine 3.9. * **27.12.18:** - Initial Release. + diff --git a/images/docker-headphones.md b/images/docker-headphones.md index 43ea64add..07eb58337 100644 --- a/images/docker-headphones.md +++ b/images/docker-headphones.md @@ -1,37 +1,30 @@ -# [linuxserver/headphones](https://github.com/linuxserver/docker-headphones) +# linuxserver/headphones -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/headphones.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/headphones.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-headphones/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-headphones/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/headphones/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/headphones/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones) [![](https://images.microbadger.com/badges/image/linuxserver/headphones.svg)](https://microbadger.com/images/linuxserver/headphones) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/headphones.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/headphones.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-headphones/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-headphones/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/headphones/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/headphones/latest/index.html) [Headphones](https://github.com/rembo10/headphones) is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole. ## 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/). +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/). Simply pulling `linuxserver/headphones` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=headphones \ -e PUID=1000 \ @@ -45,7 +38,6 @@ docker create \ linuxserver/headphones ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -72,48 +64,43 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8181` | 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. | | `/music` | Your music 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) ``` - - ## Support Info * Shell access whilst the container is running: @@ -131,7 +118,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **16.01.19:** - Add pipeline logic and multi arch. * **18.08.18:** - Rebase to alpine 3.8. * **03.04.18:** - Remove forced port and update README. -* **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. * **20.07.17:** - Internal git pull instead of at runtime. * **12.07.17:** - Add inspect commands to README, move to jenkins build and push. @@ -144,3 +131,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **27.08.16:** - Add badges to README, compile shntool. * **08.08.16:** - Rebase to alpine linux. * **18.07.15:** - Inital Release + diff --git a/images/docker-heimdall.md b/images/docker-heimdall.md old mode 100755 new mode 100644 index 21808e7c4..09adaaa1c --- a/images/docker-heimdall.md +++ b/images/docker-heimdall.md @@ -1,27 +1,19 @@ -# [linuxserver/heimdall](https://github.com/linuxserver/docker-heimdall) +# linuxserver/heimdall -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/heimdall.svg)](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/heimdall.svg)](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/heimdall.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/heimdall.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-heimdall/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-heimdall/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/heimdall/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/heimdall/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/heimdall.svg)](https://microbadger.com/images/linuxserver/heimdall) [![](https://images.microbadger.com/badges/image/linuxserver/heimdall.svg)](https://microbadger.com/images/linuxserver/heimdall) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/heimdall.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/heimdall.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-heimdall/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-heimdall/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/heimdall/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/heimdall/latest/index.html) -[Heimdall](https://heimdall.site) is a way to organise all those links to your most used web sites and web applications in a simple way. -Simplicity is the key to Heimdall. -Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo. +[Heimdall](https://heimdall.site) is a way to organise all those links to your most used web sites and web applications in a simple way. Simplicity is the key to Heimdall. Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo. ## 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/). +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/). Simply pulling `linuxserver/heimdall` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. The architectures supported by this image are: | Architecture | Tag | -| :----: | --- | +| :---: | :--- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v6-latest | @@ -31,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 Heimdall releases. | | development | Latest commit from the github master branch. | @@ -41,7 +33,7 @@ Here are some example snippets to help you get started creating a container from ### docker -``` +```text docker create \ --name=heimdall \ -e PUID=1000 \ @@ -54,7 +46,6 @@ docker create \ linuxserver/heimdall ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -80,55 +71,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 `:` 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 `:` 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` | http gui | | `443` | https gui | - -### 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` | Contains all relevant 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) ``` ## Application Setup -Access the web gui at http://SERVERIP:PORT - +Access the web gui at [http://SERVERIP:PORT](http://SERVERIP:PORT) ### Adding password protection -This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd `. Replace with a username of your choice and you will be asked to enter a password. New installs will automatically pick it up and implement password protected access. Existing users updating their image can delete their site config at `/config/nginx/site-confs/default` and restart the container after updating the image. A new site config with htpasswd support will be created in its place. - - +This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd `. Replace with a username of your choice and you will be asked to enter a password. New installs will automatically pick it up and implement password protected access. Existing users updating their image can delete their site config at `/config/nginx/site-confs/default` and restart the container after updating the image. A new site config with htpasswd support will be created in its place. ## Support Info @@ -150,9 +135,10 @@ This image now supports password protection through htpasswd. Run the following * **04.11.18:** - Add php7-zip. * **31.10.18:** - Add queue service. * **17.10.18:** - Symlink avatars folder. -* **16.10.18:** - Updated fastcgi_params for user login support. +* **16.10.18:** - Updated fastcgi\_params for user login support. * **07.10.18:** - Symlink `.env` rather than copy. It now resides under `/config/www` * **30.09.18:** - Multi-arch image. Move `.env` to `/config`. * **05.09.18:** - Rebase to alpine linux 3.8. * **06.03.18:** - Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default and restart the container, a new default site config with htpasswd support will be created in its place * **12.02.18:** - Initial Release. + diff --git a/images/docker-htpcmanager.md b/images/docker-htpcmanager.md old mode 100755 new mode 100644 index 53115d094..d4049048e --- a/images/docker-htpcmanager.md +++ b/images/docker-htpcmanager.md @@ -1,37 +1,30 @@ -# [linuxserver/htpcmanager](https://github.com/linuxserver/docker-htpcmanager) +# linuxserver/htpcmanager -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/htpcmanager.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/htpcmanager.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-htpcmanager/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-htpcmanager/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager) [![](https://images.microbadger.com/badges/image/linuxserver/htpcmanager.svg)](https://microbadger.com/images/linuxserver/htpcmanager) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/htpcmanager.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/htpcmanager.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-htpcmanager/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-htpcmanager/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/htpcmanager/latest/index.html) [Htpcmanager](https://github.com/Hellowlol/HTPC-Manager) is a front end for many htpc related applications. Hellowlol version. ## 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/). +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/). Simply pulling `linuxserver/htpcmanager` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=htpcmanager \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/htpcmanager ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8085` | 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. | - - ## 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) ``` @@ -110,7 +99,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel The webui is found at port 8085. Smartmontools has not been included, you can safely ignore the warning error in the log. - ## Support Info * Shell access whilst the container is running: @@ -138,3 +126,4 @@ The webui is found at port 8085. Smartmontools has not been included, you can sa * **08.08.16:** - Rebase to alpine linux. * **14.01.15:** - Remove hardcoded loglevel from the run command, set in webui * **19.09.15:** - Initial Release. + diff --git a/images/docker-hydra.md b/images/docker-hydra.md old mode 100755 new mode 100644 index 52175c767..42f092bde --- a/images/docker-hydra.md +++ b/images/docker-hydra.md @@ -1,37 +1,30 @@ -# [linuxserver/hydra](https://github.com/linuxserver/docker-hydra) +# linuxserver/hydra -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/hydra.svg)](https://microbadger.com/images/linuxserver/hydra "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/hydra.svg)](https://microbadger.com/images/linuxserver/hydra "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-hydra/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/hydra.svg)](https://microbadger.com/images/linuxserver/hydra) [![](https://images.microbadger.com/badges/image/linuxserver/hydra.svg)](https://microbadger.com/images/linuxserver/hydra) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-hydra/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra/latest/index.html) [Hydra](https://github.com/theotherp/nzbhydra) is a meta search for NZB indexers and the "spiritual successor" to NZBmegasearcH. It provides easy access to a number of raw and newznab based indexers. ## 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/). +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/). Simply pulling `linuxserver/hydra` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=hydra \ -e PUID=1000 \ @@ -44,7 +37,6 @@ docker create \ linuxserver/hydra ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -70,41 +62,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `5075` | 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 hydra should store config files. | | `/downloads` | NZB download folder. | - - ## 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) ``` @@ -113,8 +102,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel The web interface is at `:5075` , to set up indexers and connections to your nzb download applications. - - ## Support Info * Shell access whilst the container is running: @@ -140,3 +127,4 @@ The web interface is at `:5075` , to set up indexers and connections to * **28.08.16:** - Add badges to README. * **08.08.16:** - Rebase to alpine linux. * **25.01.16:** - Initial Release. + diff --git a/images/docker-hydra2.md b/images/docker-hydra2.md old mode 100755 new mode 100644 index c745b6388..f992c05a2 --- a/images/docker-hydra2.md +++ b/images/docker-hydra2.md @@ -1,40 +1,32 @@ -# [linuxserver/hydra2](https://github.com/linuxserver/docker-hydra2) +# linuxserver/hydra2 -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/hydra2.svg)](https://microbadger.com/images/linuxserver/hydra2 "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/hydra2.svg)](https://microbadger.com/images/linuxserver/hydra2 "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra2.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra2.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-hydra2/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra2/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/hydra2.svg)](https://microbadger.com/images/linuxserver/hydra2) [![](https://images.microbadger.com/badges/image/linuxserver/hydra2.svg)](https://microbadger.com/images/linuxserver/hydra2) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra2.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra2.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-hydra2/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra2/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/index.html) [Hydra2](https://github.com/theotherp/nzbhydra2) is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application [NZBHydra](https://github.com/theotherp/nzbhydra). It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is currently in its early stages and is in active development. Be wary that there may be some compatibility issues for those migrating from V1 to V2, so ensure you back up your old configuration before moving over to the new version. - ## 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/). +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/). Simply pulling `linuxserver/hydra2` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=hydra2 \ -e PUID=1000 \ @@ -47,7 +39,6 @@ docker create \ linuxserver/hydra2 ``` - ### 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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `5076` | 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 hydra2 should store config files. | | `/downloads` | NZB download folder. | - - ## 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,8 +104,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel The web interface is at `:5076` , to set up indexers and connections to your nzb download applications. - - ## Support Info * Shell access whilst the container is running: @@ -132,7 +118,8 @@ The web interface is at `:5076` , to set up indexers and connections to ## Versions * **11.02.19:** - Add pipeline logic and multi arch. -* **18.08.18:** - Bump java version to 10, (bionic currently refers to it as version 11). +* **18.08.18:** - Bump java version to 10, \(bionic currently refers to it as version 11\). * **10.08.18:** - Rebase to ubuntu bionic. * **15.04.18:** - Change to port 5076 in the Dockerfile. * **11.01.18:** - Initial Release. + diff --git a/images/docker-jackett.md b/images/docker-jackett.md old mode 100755 new mode 100644 index 97ce8b7ef..2b19f5add --- a/images/docker-jackett.md +++ b/images/docker-jackett.md @@ -1,25 +1,19 @@ -# [linuxserver/jackett](https://github.com/linuxserver/docker-jackett) +# linuxserver/jackett -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/jackett.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/jackett.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-jackett/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jackett/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett) [![](https://images.microbadger.com/badges/image/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/jackett.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/jackett.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-jackett/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jackett/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/index.html) -[Jackett](https://github.com/Jackett/Jackett) works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. +[Jackett](https://github.com/Jackett/Jackett) works as a proxy server: it translates queries from apps \(Sonarr, SickRage, CouchPotato, Mylar, etc\) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads \(like RSS\) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. ## 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/). +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/). Simply pulling `linuxserver/jackett` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 Jackett Releases | | development | Latest Jackett Releases | @@ -39,7 +33,7 @@ Here are some example snippets to help you get started creating a container from ### docker -``` +```text docker create \ --name=jackett \ -e PUID=1000 \ @@ -53,7 +47,6 @@ docker create \ linuxserver/jackett ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -80,55 +73,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `9117` | 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. | | `RUN_OPTS=` | Optionally specify additional arguments to be passed. EG. `--ProxyConnection=10.0.0.100:1234`. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where Jackett should store its config file. | | `/downloads` | Path to torrent blackhole. | - - ## 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 web interface is at `:9117` , configure various trackers and connections to other apps there. -More info at [Jackett](https://github.com/Jackett/Jackett). +The web interface is at `:9117` , configure various trackers and connections to other apps there. More info at [Jackett](https://github.com/Jackett/Jackett). Disable autoupdates in the webui to prevent jackett crashing, the image is refreshed when new versions are released. - - ## Support Info * Shell access whilst the container is running: @@ -155,3 +142,4 @@ Disable autoupdates in the webui to prevent jackett crashing, the image is refre * **28.08.16:** - Add badges to README. * **06.08.16:** - Rebase to alpine linux for smaller image. * **25.01.16:** - Initial Release. + diff --git a/images/docker-lazylibrarian.md b/images/docker-lazylibrarian.md index 44103de13..c749a00d4 100644 --- a/images/docker-lazylibrarian.md +++ b/images/docker-lazylibrarian.md @@ -1,38 +1,30 @@ -# [linuxserver/lazylibrarian](https://github.com/linuxserver/docker-lazylibrarian) +# linuxserver/lazylibrarian -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/lazylibrarian.svg)](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/lazylibrarian.svg)](https://microbadger.com/images/linuxserver/lazylibrarian "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lazylibrarian.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lazylibrarian.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lazylibrarian/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/badge.svg)](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://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/lazylibrarian.svg)](https://microbadger.com/images/linuxserver/lazylibrarian) [![](https://images.microbadger.com/badges/image/linuxserver/lazylibrarian.svg)](https://microbadger.com/images/linuxserver/lazylibrarian) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lazylibrarian.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lazylibrarian.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lazylibrarian/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lazylibrarian/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lazylibrarian/latest/badge.svg)](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 -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/). +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/). Simply pulling `linuxserver/lazylibrarian` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 `:` 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 `:` 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://: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://: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://: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 + diff --git a/images/docker-ldap-auth.md b/images/docker-ldap-auth.md old mode 100755 new mode 100644 index fd6a4029b..ec433a1d7 --- a/images/docker-ldap-auth.md +++ b/images/docker-ldap-auth.md @@ -1,37 +1,30 @@ -# [linuxserver/ldap-auth](https://github.com/linuxserver/docker-ldap-auth) +# linuxserver/ldap-auth -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/ldap-auth.svg)](https://microbadger.com/images/linuxserver/ldap-auth "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/ldap-auth.svg)](https://microbadger.com/images/linuxserver/ldap-auth "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ldap-auth.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ldap-auth.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ldap-auth/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ldap-auth/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ldap-auth/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ldap-auth/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/ldap-auth.svg)](https://microbadger.com/images/linuxserver/ldap-auth) [![](https://images.microbadger.com/badges/image/linuxserver/ldap-auth.svg)](https://microbadger.com/images/linuxserver/ldap-auth) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ldap-auth.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ldap-auth.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ldap-auth/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ldap-auth/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ldap-auth/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ldap-auth/latest/index.html) -[Ldap-auth](https://github.com/nginxinc/nginx-ldap-auth) software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012). +[Ldap-auth](https://github.com/nginxinc/nginx-ldap-auth) software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon \(ldap-auth\) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol \(LDAP\) authentication server \(OpenLDAP or Microsoft Windows Active Directory 2003 and 2012\). ## 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/). +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/). Simply pulling `linuxserver/ldap-auth` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=ldap-auth \ -e TZ=Europe/London \ @@ -41,7 +34,6 @@ docker create \ linuxserver/ldap-auth ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -63,35 +55,31 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8888` | the port for ldap auth daemon | | `9000` | the port for ldap login page | - -### Environment Variables (`-e`) +### Environment Variables \(`-e`\) | Env | Function | -| :----: | --- | +| :---: | :--- | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | - +| :---: | :--- | ## Application Setup -- This container itself does not have any settings and it relies on the pertinent information passed through in http headers of incoming requests. Make sure that your webserver is set up with the right config. -- Here's a sample config: [nginx-ldap-auth.conf](https://github.com/nginxinc/nginx-ldap-auth/blob/master/nginx-ldap-auth.conf). - - +* This container itself does not have any settings and it relies on the pertinent information passed through in http headers of incoming requests. Make sure that your webserver is set up with the right config. +* Here's a sample config: [nginx-ldap-auth.conf](https://github.com/nginxinc/nginx-ldap-auth/blob/master/nginx-ldap-auth.conf). ## Support Info @@ -110,3 +98,4 @@ Docker images are configured using parameters passed at runtime (such as those a * **18.09.18:** - Update pip * **14.09.18:** - Add TZ parameter, remove unnecessary PUID/PGID params * **11.08.18:** - Initial release. + diff --git a/images/docker-letsencrypt.md b/images/docker-letsencrypt.md old mode 100755 new mode 100644 index da03d5b08..ba57bbdf4 --- a/images/docker-letsencrypt.md +++ b/images/docker-letsencrypt.md @@ -1,37 +1,30 @@ -# [linuxserver/letsencrypt](https://github.com/linuxserver/docker-letsencrypt) +# linuxserver/letsencrypt -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/letsencrypt.svg)](https://microbadger.com/images/linuxserver/letsencrypt "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/letsencrypt.svg)](https://microbadger.com/images/linuxserver/letsencrypt "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/letsencrypt.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/letsencrypt.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-letsencrypt/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-letsencrypt/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/letsencrypt/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/letsencrypt/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/letsencrypt.svg)](https://microbadger.com/images/linuxserver/letsencrypt) [![](https://images.microbadger.com/badges/image/linuxserver/letsencrypt.svg)](https://microbadger.com/images/linuxserver/letsencrypt) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/letsencrypt.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/letsencrypt.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-letsencrypt/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-letsencrypt/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/letsencrypt/latest/badge.svg)](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. ## 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/). +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/). Simply pulling `linuxserver/letsencrypt` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 `:` 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 `:` 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=` | Required if `VALIDATION` is set to `duckdns`. Retrieve your token from https://www.duckdns.org | +| `DUCKDNSTOKEN=` | Required if `VALIDATION` is set to `duckdns`. Retrieve your token from [https://www.duckdns.org](https://www.duckdns.org) | | `EMAIL=` | 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=` | 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=` | 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 ` * 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//` (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//` \(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 ` * You can unban an IP via `docker exec -it letsencrypt fail2ban-client set unbanip ` -* 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 + diff --git a/images/docker-libresonic.md b/images/docker-libresonic.md old mode 100755 new mode 100644 index b9b7028c4..cc6aff4c3 --- a/images/docker-libresonic.md +++ b/images/docker-libresonic.md @@ -1,37 +1,30 @@ -# [linuxserver/libresonic](https://github.com/linuxserver/docker-libresonic) +# linuxserver/libresonic -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/libresonic.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/libresonic.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-libresonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-libresonic/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/libresonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/libresonic/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic) [![](https://images.microbadger.com/badges/image/linuxserver/libresonic.svg)](https://microbadger.com/images/linuxserver/libresonic) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/libresonic.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/libresonic.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-libresonic/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-libresonic/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/libresonic/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/libresonic/latest/index.html) [Libresonic](https://github.com/Libresonic/libresonic) is a free, web-based media streamer, providing ubiqutious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. ## 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/). +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/). Simply pulling `linuxserver/libresonic` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=libresonic \ -e PUID=1000 \ @@ -48,7 +41,6 @@ docker create \ linuxserver/libresonic ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -79,45 +71,42 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `4040` | 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. | | `CONTEXT_PATH=` | For setting url-base in reverse proxy setups. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Configuration file location. | | `/music` | Location of music. | | `/playlists` | Location for playlists to be saved to. | | `/podcasts` | Location of podcasts. | | `/media` | Location of other media. | - - ## 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 +117,6 @@ Access WebUI at `:4040`. Default user/pass is admin/admin - - ## Support Info * Shell access whilst the container is running: @@ -148,8 +135,9 @@ Default user/pass is admin/admin * **27.08.18:** - Rebase to ubuntu bionic. * **12.12.17:** - Rebase to alpine 3.7. * **11.07.17:** - Rebase to alpine 3.6. -* **12.05.17:** - Add annotation timeout (primarily for armhf and lower powered hosts). +* **12.05.17:** - Add annotation timeout \(primarily for armhf and lower powered hosts\). * **08.02.17:** - Rebase to alpine 3.5. * **04.12.16:** - Update jetty runner version. * **29.11.16:** - Switch to building from release tags following v6.1 stable release. * **17.11.16:** - Initial Release. + diff --git a/images/docker-lidarr.md b/images/docker-lidarr.md old mode 100755 new mode 100644 index 6cfda3883..fed57772c --- a/images/docker-lidarr.md +++ b/images/docker-lidarr.md @@ -1,25 +1,19 @@ -# [linuxserver/lidarr](https://github.com/linuxserver/docker-lidarr) +# linuxserver/lidarr -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lidarr.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lidarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lidarr/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr) [![](https://images.microbadger.com/badges/image/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lidarr.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lidarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lidarr/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/badge.svg)](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. ## 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/). +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/). Simply pulling `linuxserver/lidarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 `:` 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 `:` 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 `: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 `: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. + diff --git a/images/docker-lychee.md b/images/docker-lychee.md old mode 100755 new mode 100644 index 311372d6f..f5c013cf4 --- a/images/docker-lychee.md +++ b/images/docker-lychee.md @@ -1,37 +1,30 @@ -# [linuxserver/lychee](https://github.com/linuxserver/docker-lychee) +# linuxserver/lychee -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/lychee.svg)](https://microbadger.com/images/linuxserver/lychee "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/lychee.svg)](https://microbadger.com/images/linuxserver/lychee "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lychee.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lychee.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lychee/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/lychee.svg)](https://microbadger.com/images/linuxserver/lychee) [![](https://images.microbadger.com/badges/image/linuxserver/lychee.svg)](https://microbadger.com/images/linuxserver/lychee) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lychee.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lychee.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lychee/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lychee/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lychee/latest/index.html) [Lychee](https://lychee.electerious.com/) is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely. ## 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/). +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/). Simply pulling `linuxserver/lychee` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=lychee \ -e PUID=1000 \ @@ -44,7 +37,6 @@ docker create \ linuxserver/lychee ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -70,52 +62,47 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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` | http gui | - -### 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` | Contains all relevant configuration files. | | `/pictures` | Where lychee will store uploaded 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 -Set up mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT +Set up mysql/mariadb and account via the webui, accessible at [http://SERVERIP:PORT](http://SERVERIP:PORT) You can change the php upload limits by editing the file `/config/lychee/user.ini` and restarting the container. -More info at [lychee](https://lychee.electerious.com/). - - +More info at [lychee](https://lychee.electerious.com/). ## Support Info @@ -139,3 +126,4 @@ More info at [lychee](https://lychee.electerious.com/). * **25.05.17:** - Rebase to alpine 3.6. * **03.05.17:** - Use repo pinning to better solve dependencies, use repo version of php7-imagick. * **12.02.17:** - Initial Release. + diff --git a/images/docker-mariadb.md b/images/docker-mariadb.md old mode 100755 new mode 100644 index 3f003a00c..8ef9bfb19 --- a/images/docker-mariadb.md +++ b/images/docker-mariadb.md @@ -1,37 +1,30 @@ -# [linuxserver/mariadb](https://github.com/linuxserver/docker-mariadb) +# linuxserver/mariadb -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-mariadb/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb) [![](https://images.microbadger.com/badges/image/linuxserver/mariadb.svg)](https://microbadger.com/images/linuxserver/mariadb) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mariadb.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mariadb.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-mariadb/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mariadb/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mariadb/latest/badge.svg)](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. ## 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/). +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/). Simply pulling `linuxserver/mariadb` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 `:` 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 `:` 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=` | Set this to root password for installation (minimum 4 characters). | +| `MYSQL_ROOT_PASSWORD=` | Set this to root password for installation \(minimum 4 characters\). | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `MYSQL_DATABASE=` | Specify the name of a database to be created on image startup. | -| `MYSQL_USER=` | This user will have superuser access to the database specified by MYSQL_DATABASE. | -| `MYSQL_PASSWORD=` | Set this to the password you want to use for you MYSQL_USER (minimum 4 characters). | +| `MYSQL_USER=` | This user will have superuser access to the database specified by MYSQL\_DATABASE. | +| `MYSQL_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 ` -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 ` 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. + diff --git a/images/docker-medusa.md b/images/docker-medusa.md old mode 100755 new mode 100644 index 68b8a0ff1..ec453b3be --- a/images/docker-medusa.md +++ b/images/docker-medusa.md @@ -1,38 +1,30 @@ -# [linuxserver/medusa](https://github.com/linuxserver/docker-medusa) +# linuxserver/medusa -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/medusa.svg)](https://microbadger.com/images/linuxserver/medusa "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/medusa.svg)](https://microbadger.com/images/linuxserver/medusa "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/medusa.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-medusa/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-medusa/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/medusa/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/medusa/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/medusa.svg)](https://microbadger.com/images/linuxserver/medusa) [![](https://images.microbadger.com/badges/image/linuxserver/medusa.svg)](https://microbadger.com/images/linuxserver/medusa) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/medusa.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/medusa.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-medusa/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-medusa/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/medusa/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/medusa/latest/index.html) [Medusa](https://pymedusa.com/) 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/). +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/). Simply pulling `linuxserver/medusa` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=medusa \ -e PUID=1000 \ @@ -46,7 +38,6 @@ docker create \ linuxserver/medusa ``` - ### 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 `:` 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 `:` 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` | The port for the Medusa 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 e.g. Europe/London | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Cardigann config | | `/downloads` | Download location | | `/tv` | TV Shows 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 Web interface is at `:8081` , set paths for downloads, tv-shows to match docker mappings via the webui, for more information check out [Medusa](https://pymedusa.com/). - - ## Support Info * Shell access whilst the container is running: @@ -143,3 +129,4 @@ Web interface is at `:8081` , set paths for downloads, tv-shows to matc * **25.05.17:** - Rebase to alpine 3.6 * **07.02.17:** - Rebase to alpine 3.5 * **02.01.17:** - Initial Release + diff --git a/images/docker-minetest.md b/images/docker-minetest.md old mode 100755 new mode 100644 index fd66abb67..8881daf0a --- a/images/docker-minetest.md +++ b/images/docker-minetest.md @@ -1,37 +1,30 @@ -# [linuxserver/minetest](https://github.com/linuxserver/docker-minetest) +# linuxserver/minetest -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minetest.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-minetest/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-minetest/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minetest/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minetest/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest) [![](https://images.microbadger.com/badges/image/linuxserver/minetest.svg)](https://microbadger.com/images/linuxserver/minetest) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minetest.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minetest.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-minetest/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-minetest/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minetest/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minetest/latest/index.html) -[Minetest](http://www.minetest.net/) (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. +[Minetest](http://www.minetest.net/) \(server\) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. ## 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/). +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/). Simply pulling `linuxserver/minetest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=minetest \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/minetest ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `30000/udp` | Port Minetest listens on. | - -### 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/.minetest` | Where minetest stores config files and maps etc. | - - ## User / Group Identifiers -When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. +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) ``` @@ -112,9 +101,7 @@ You can find the world maps, mods folder and config files in /config/.minetest. Client and server must be the same version, please browse the tags here to pull the appropriate version for your server: -https://hub.docker.com/r/linuxserver/minetest/tags - - +[https://hub.docker.com/r/linuxserver/minetest/tags](https://hub.docker.com/r/linuxserver/minetest/tags) ## Support Info @@ -132,7 +119,7 @@ https://hub.docker.com/r/linuxserver/minetest/tags * **04.03.19:** - Rebase to alpine 3.9 to compile 5.0.0 minetest with new build args. * **14.01.19:** - Add pipeline logic and multi arch. * **08.08.18:** - Rebase to alpine 3.8, build from latest release tag instead of master. -* **03.01.18:** - Deprecate cpu_core routine lack of scaling. +* **03.01.18:** - Deprecate cpu\_core routine lack of scaling. * **08.12.17:** - Rebase to alpine 3.7. * **30.11.17:** - Use cpu core counting routine to speed up build time. * **26.05.17:** - Rebase to alpine 3.6. @@ -143,3 +130,4 @@ https://hub.docker.com/r/linuxserver/minetest/tags * **15.02.16:** - Make minetest app a service. * **01.02.16:** - Add lua-socket dependency. * **06.11.15:** - Initial Release. + diff --git a/images/docker-minisatip.md b/images/docker-minisatip.md index f64962c98..6629e4d79 100644 --- a/images/docker-minisatip.md +++ b/images/docker-minisatip.md @@ -1,37 +1,30 @@ -# [linuxserver/minisatip](https://github.com/linuxserver/docker-minisatip) +# linuxserver/minisatip -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minisatip.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minisatip.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-minisatip/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-minisatip/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minisatip/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minisatip/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip) [![](https://images.microbadger.com/badges/image/linuxserver/minisatip.svg)](https://microbadger.com/images/linuxserver/minisatip) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/minisatip.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/minisatip.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-minisatip/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-minisatip/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minisatip/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/minisatip/latest/index.html) [Minisatip](https://github.com/catalinii/minisatip) is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards. ## 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/). +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/). Simply pulling `linuxserver/minisatip` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=minisatip \ -e PUID=1000 \ @@ -49,9 +42,7 @@ docker create \ ### Additional runtime parameters -In some cases it might be necessary to start minisatip with additional parameters, for example to configure a unicable LNB. Add the parameters you need and restart the container. Be sure to have the right parameters set as adding the wrong once might lead to the container not starting correctly. -For a list of minisatip parameters visit [Minisatip](https://github.com/catalinii/minisatip) page. - +In some cases it might be necessary to start minisatip with additional parameters, for example to configure a unicable LNB. Add the parameters you need and restart the container. Be sure to have the right parameters set as adding the wrong once might lead to the container not starting correctly. For a list of minisatip parameters visit [Minisatip](https://github.com/catalinii/minisatip) page. ### docker-compose @@ -82,47 +73,46 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8875` | Status Page WebUI | | `554` | RTSP Port | | `1900/udp` | App Discovery | - -### 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. | | `RUN_OPTS=` | Specify specific run params for minisatip | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Configuration files and minisatip data | -#### Device Mappings (`--device`) -| Parameter | Function | -| :-----: | --- | -| `/dev/dvb` | For passing through Tv-cards | +#### Device Mappings \(`--device`\) +| Parameter | Function | +| :---: | :--- | +| `/dev/dvb` | For passing through Tv-cards | ## 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) ``` @@ -135,8 +125,6 @@ There is no setup per se, other than adding your cards for passthrough. You can then use your cards as DVB inputs in apps such as tvheadend. - - ## Support Info * Shell access whilst the container is running: @@ -162,3 +150,4 @@ You can then use your cards as DVB inputs in apps such as tvheadend. * **11.09.16:** - Add layer badges to README. * **28.08.16:** - Add badges to README. * **15.08.16:** - Initial Release. + diff --git a/images/docker-muximux.md b/images/docker-muximux.md old mode 100755 new mode 100644 index c86c3b305..be1fd5d96 --- a/images/docker-muximux.md +++ b/images/docker-muximux.md @@ -1,37 +1,30 @@ -# [linuxserver/muximux](https://github.com/linuxserver/docker-muximux) +# linuxserver/muximux -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/muximux.svg)](https://microbadger.com/images/linuxserver/muximux "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/muximux.svg)](https://microbadger.com/images/linuxserver/muximux "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/muximux.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/muximux.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-muximux/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-muximux/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/muximux.svg)](https://microbadger.com/images/linuxserver/muximux) [![](https://images.microbadger.com/badges/image/linuxserver/muximux.svg)](https://microbadger.com/images/linuxserver/muximux) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/muximux.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/muximux.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-muximux/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-muximux/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/muximux/latest/index.html) [Muximux](https://github.com/mescon/Muximux) is a lightweight portal to view & manage your HTPC apps without having to run anything more than a PHP enabled webserver. With Muximux you don't need to keep multiple tabs open, or bookmark the URL to all of your apps. ## 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/). +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/). Simply pulling `linuxserver/muximux` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=muximux \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/muximux ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,50 +60,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where muximux should store its 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 -Find the web interface at `:80` , set apps you wish to use with muximux via the webui. -More info:- [Muximux](https://github.com/mescon/Muximux) - - +Find the web interface at `:80` , set apps you wish to use with muximux via the webui. More info:- [Muximux](https://github.com/mescon/Muximux) ## Support Info @@ -136,3 +122,4 @@ More info:- [Muximux](https://github.com/mescon/Muximux) * **30.09.16:** - Rebase to alpine linux. * **09.09.16:** - Add badges to README. * **22.02.16:** - Initial release date. + diff --git a/images/docker-mylar.md b/images/docker-mylar.md index ab98db9c4..825023fa8 100644 --- a/images/docker-mylar.md +++ b/images/docker-mylar.md @@ -1,37 +1,30 @@ -# [linuxserver/mylar](https://github.com/linuxserver/docker-mylar) +# linuxserver/mylar -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-mylar/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mylar/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar) [![](https://images.microbadger.com/badges/image/linuxserver/mylar.svg)](https://microbadger.com/images/linuxserver/mylar) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/mylar.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/mylar.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-mylar/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-mylar/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/mylar/latest/index.html) -[Mylar](https://github.com/evilhero/mylar) is an automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents. +[Mylar](https://github.com/evilhero/mylar) is an automated Comic Book downloader \(cbr/cbz\) for use with SABnzbd, NZBGet and torrents. ## 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/). +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/). Simply pulling `linuxserver/mylar` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=mylar \ -e PUID=1000 \ @@ -44,7 +37,6 @@ docker create \ linuxserver/mylar ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -70,51 +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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8090` | 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 | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where mylar should store config files. | | `/comics` | Map to your comics folder. | | `/downloads` | Map to your downloads folder. | - - ## 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 web ui for settings etc, is on `:8090` -For more detailed setup refer [Mylar](https://github.com/evilhero/mylar). - - +The web ui for settings etc, is on `:8090` For more detailed setup refer [Mylar](https://github.com/evilhero/mylar). ## Support Info @@ -144,3 +130,4 @@ For more detailed setup refer [Mylar](https://github.com/evilhero/mylar). * **28.08.16:** - Add badges to README. * **08.08.16:** - Rebase to alpine linux. * **26.01.16:** - Initial release. + diff --git a/images/docker-nextcloud.md b/images/docker-nextcloud.md old mode 100755 new mode 100644 index cd798d8d9..266c0e321 --- a/images/docker-nextcloud.md +++ b/images/docker-nextcloud.md @@ -1,40 +1,32 @@ -# [linuxserver/nextcloud](https://github.com/linuxserver/docker-nextcloud) +# linuxserver/nextcloud -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/nextcloud.svg)](https://microbadger.com/images/linuxserver/nextcloud "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/nextcloud.svg)](https://microbadger.com/images/linuxserver/nextcloud "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nextcloud.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nextcloud.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nextcloud/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nextcloud/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nextcloud/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nextcloud/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/nextcloud.svg)](https://microbadger.com/images/linuxserver/nextcloud) [![](https://images.microbadger.com/badges/image/linuxserver/nextcloud.svg)](https://microbadger.com/images/linuxserver/nextcloud) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nextcloud.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nextcloud.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nextcloud/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nextcloud/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nextcloud/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nextcloud/latest/index.html) [Nextcloud](https://nextcloud.com/) gives you access to all your files wherever you are. Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home. - ## 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/). +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/). Simply pulling `linuxserver/nextcloud` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=nextcloud \ -e PUID=1000 \ @@ -47,7 +39,6 @@ docker create \ linuxserver/nextcloud ``` - ### 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 `:` 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 `:` 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` | Nextcloud configs. | | `/data` | Your personal 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) ``` @@ -117,12 +105,12 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:443`, for more information check out [Nextcloud](https://nextcloud.com/). If you are updating our container along with the in app updater and you are not customizing our default nginx configuration you will need to remove the file: -``` + +```text /config/nginx/site-confs/default ``` -Then restart the container to replace it with the latest one. - +Then restart the container to replace it with the latest one. ## Support Info @@ -154,3 +142,4 @@ Then restart the container to replace it with the latest one. * **22.05.17:** - Update to nextcloud 12.0, adding required dependecies and note about commenting out SAMEORIGIN; line. * **03.05.17:** - Use community repo of memcache. * **07.03.17:** - Release into main repository and upgrade to php7 and Alpine 3.5. + diff --git a/images/docker-nginx.md b/images/docker-nginx.md old mode 100755 new mode 100644 index 6c40cf157..ec3a8baa3 --- a/images/docker-nginx.md +++ b/images/docker-nginx.md @@ -1,37 +1,30 @@ -# [linuxserver/nginx](https://github.com/linuxserver/docker-nginx) +# linuxserver/nginx -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nginx.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nginx.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nginx/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nginx/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx) [![](https://images.microbadger.com/badges/image/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nginx.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nginx.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nginx/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nginx/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nginx/latest/index.html) [Nginx](https://nginx.org/) is a simple webserver with php support. The config files reside in `/config` for easy user customization. ## 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/). +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/). Simply pulling `linuxserver/nginx` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=nginx \ -e PUID=1000 \ @@ -44,7 +37,6 @@ docker create \ linuxserver/nginx ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -70,41 +62,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 `:` 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 `:` 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` | http | | `443` | https | - -### 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` | Contains your www content and all relevant 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) ``` @@ -113,9 +102,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Add your web files to `/config/www` for hosting. Modify the nginx, php and site config files under `/config` as needed -*Protip: This container is best combined with a sql server, e.g. [mariadb](https://hub.docker.com/r/linuxserver/mariadb/)* - - +_Protip: This container is best combined with a sql server, e.g._ [_mariadb_](https://hub.docker.com/r/linuxserver/mariadb/) ## Support Info @@ -131,7 +118,7 @@ Modify the nginx, php and site config files under `/config` as needed ## Versions * **02.03.19:** - Add php intl and posix modules. -* **28.02.19:** - Add php7-opcache, remove memcached service due to issues on aarch64 (let us know if you need to enable it). +* **28.02.19:** - Add php7-opcache, remove memcached service due to issues on aarch64 \(let us know if you need to enable it\). * **22.02.19:** - Rebasing to alpine 3.9. * **18.11.18:** - Attempt to upgrade packages during build. * **28.09.18:** - Multi-arch image. @@ -153,3 +140,4 @@ Modify the nginx, php and site config files under `/config` as needed * **14.10.16:** - Add version layer information. * **10.09.16:** - Add badges to README. * **05.12.15:** - Intial Release. + diff --git a/images/docker-nzbget.md b/images/docker-nzbget.md old mode 100755 new mode 100644 index 5e22270c1..bd17e7fc6 --- a/images/docker-nzbget.md +++ b/images/docker-nzbget.md @@ -1,25 +1,19 @@ -# [linuxserver/nzbget](https://github.com/linuxserver/docker-nzbget) +# linuxserver/nzbget -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nzbget.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nzbget/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nzbget/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget) [![](https://images.microbadger.com/badges/image/linuxserver/nzbget.svg)](https://microbadger.com/images/linuxserver/nzbget) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nzbget.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nzbget.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-nzbget/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-nzbget/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/nzbget/latest/index.html) [Nzbget](http://nzbget.net/) is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources. ## 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/). +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/). Simply pulling `linuxserver/nzbget` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 nzbget releases | | testing | nzbget pre-releases | @@ -39,7 +33,7 @@ Here are some example snippets to help you get started creating a container from ### docker -``` +```text docker create \ --name=nzbget \ -e PUID=1000 \ @@ -52,7 +46,6 @@ docker create \ linuxserver/nzbget ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,48 +71,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `6789` | 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` | NZBGet App data. | | `/downloads` | Location of downloads on disk. | - - ## 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 -Webui can be found at `:6789` and the default login details (change ASAP) are +Webui can be found at `:6789` and the default login details \(change ASAP\) are `login:nzbget, password:tegbzn6789` @@ -129,7 +119,7 @@ To change umask settings. ![](http://i.imgur.com/A4VMbwE.png) -scroll to bottom, set umask like this (example shown for unraid) +scroll to bottom, set umask like this \(example shown for unraid\) ![](http://i.imgur.com/mIqDEJJ.png) @@ -139,8 +129,6 @@ You can add an additional mount point for intermediate unpacking folder with:- for example, and changing the setting for InterDir in the PATHS tab of settings to `/intermediate` - - ## Support Info * Shell access whilst the container is running: @@ -169,3 +157,4 @@ for example, and changing the setting for InterDir in the PATHS tab of settings * **27.08.16:** - Add badges to README, perms fix on /app to allow updates. * **19.08.16:** - Rebase to alpine linux. * **18.08.15:** - Now useing latest version of unrar beta and implements the universal installer method. + diff --git a/images/docker-ombi.md b/images/docker-ombi.md old mode 100755 new mode 100644 index 55b66ad0a..510776081 --- a/images/docker-ombi.md +++ b/images/docker-ombi.md @@ -1,41 +1,30 @@ -# [linuxserver/ombi](https://github.com/linuxserver/docker-ombi) +# linuxserver/ombi -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/ombi.svg)](https://microbadger.com/images/linuxserver/ombi "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/ombi.svg)](https://microbadger.com/images/linuxserver/ombi "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ombi.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ombi.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ombi/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ombi/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/ombi.svg)](https://microbadger.com/images/linuxserver/ombi) [![](https://images.microbadger.com/badges/image/linuxserver/ombi.svg)](https://microbadger.com/images/linuxserver/ombi) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ombi.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ombi.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ombi/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ombi/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/index.html) -[Ombi](https://ombi.io) allows you to host your own Plex Request and user management system. -If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface! -Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something. -Allow your users to post issues against their requests so you know there is a problem with the audio etc. -Even automatically sent them weekly newsletters of new content that has been added to your Plex server! +[Ombi](https://ombi.io) allows you to host your own Plex Request and user management system. If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface! Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something. Allow your users to post issues against their requests so you know there is a problem with the audio etc. Even automatically sent them weekly newsletters of new content that has been added to your Plex server! ## 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/). +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/). Simply pulling `linuxserver/ombi` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=ombi \ -e PUID=1000 \ @@ -52,7 +41,6 @@ Add one of the tags, if required, to the `linuxserver/ombi` line of the run/crea The development tag will be the latest commit in the `develop` branch of ombi. HOWEVER, USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!! - ### docker-compose Compatible with docker-compose v2 schemas. @@ -77,49 +65,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `3579` | web gui | - -### 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` | Contains all relevant 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) ``` ## Application Setup -Access the webui at `:3579`. Follow the setup wizard on initial install. Then configure the required services. - - +Access the webui at `:3579`. Follow the setup wizard on initial install. Then configure the required services. ## Support Info @@ -141,3 +124,4 @@ Access the webui at `:3579`. Follow the setup wizard on initial install * **26.01.18:** - Fix continuation lines. * **16.04.17:** - Switch to using inhouse mono baseimage. * **17.02.17:** - Initial Release. + diff --git a/images/docker-openvpnas.md b/images/docker-openvpnas.md old mode 100755 new mode 100644 index 126d4d76e..5c0369d5b --- a/images/docker-openvpnas.md +++ b/images/docker-openvpnas.md @@ -1,27 +1,24 @@ -[linuxserverurl]: https://linuxserver.io -[forumurl]: https://forum.linuxserver.io -[ircurl]: https://www.linuxserver.io/irc/ -[podcasturl]: https://www.linuxserver.io/podcast/ -[appurl]: https://openvpn.net/index.php/access-server/overview.html -[hub]: https://hub.docker.com/r/linuxserver/openvpn-as/ +# linuxserver/openvpnas -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] +[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) -The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: -* [forum.linuxserver.io][forumurl] -* [IRC][ircurl] on freenode at `#linuxserver.io` -* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at: -# linuxserver/openvpn-as -[![](https://images.microbadger.com/badges/version/linuxserver/openvpn-as.svg)](https://microbadger.com/images/linuxserver/openvpn-as "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/openvpn-as.svg)](https://microbadger.com/images/linuxserver/openvpn-as "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/openvpn-as.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/openvpn-as.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-openvpn-as)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-openvpn-as/) +* [forum.linuxserver.io](https://forum.linuxserver.io) +* [IRC](https://www.linuxserver.io/irc/) on freenode at `#linuxserver.io` +* [Podcast](https://www.linuxserver.io/podcast/) covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! + +## linuxserver/openvpn-as + +[![](https://images.microbadger.com/badges/version/linuxserver/openvpn-as.svg)](https://microbadger.com/images/linuxserver/openvpn-as)[![](https://images.microbadger.com/badges/image/linuxserver/openvpn-as.svg)](https://microbadger.com/images/linuxserver/openvpn-as)[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/openvpn-as.svg)](https://hub.docker.com/r/linuxserver/openvpn-as/)[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/openvpn-as.svg)](https://hub.docker.com/r/linuxserver/openvpn-as/)[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-openvpn-as)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-openvpn-as/) OpenVPN Access Server 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. [Openvpn-as](https://openvpn.net/index.php/access-server/overview.html) -[![openvpn-as](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/openvpn-as-banner.png)][appurl] +[![openvpn-as](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/openvpn-as-banner.png)](https://openvpn.net/index.php/access-server/overview.html) -## Usage +### Usage -``` +```text docker create \ --name=openvpn-as \ --cap-add=NET_ADMIN \ @@ -34,13 +31,9 @@ docker create \ linuxserver/openvpn-as ``` -## Parameters - -`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. -For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. -So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 -http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` +### Parameters +`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` * `-v /config` - where openvpn-as should store configuration files * `-e PGID` for GroupID - see below for explanation @@ -50,40 +43,32 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po * `-p 1194/udp` udp port * `-e TZ` for Timezone setting * `--cap-add=NET_ADMIN` IMPORTANT, will not operate without this parameter. -* `-e INTERFACE` *OPTIONAL* - only needed if run in host networking (default is eth0). +* `-e INTERFACE` _OPTIONAL_ - only needed if run in host networking \(default is eth0\). It is based on ubuntu xenial with S6 overlay, for shell access whilst the container is running do `docker exec -it openvpn-as /bin/bash`. +#### User / Group Identifiers -### User / Group Identifiers - -Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. +Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™. In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: -``` +```text $ id uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) ``` - -## Setting up the application +### Setting up the application The admin interface is available at `https://: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). +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) +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\) -## Info +### Info * To monitor the logs of the container in realtime `docker logs -f openvpn-as`. - - * container version number `docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as` @@ -92,23 +77,24 @@ The "admin" account is a system (PAM) account and after container update or recr `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/openvpn-as` -## Versions +### Versions + +* **07.02.19:** Rebase to bionic, add pipeline logic. +* **31.01.19:** Add port mappings to docker create sample in readme. +* **26.01.19:** Removed `privileged` and `host` networking requirements, added `cap-add=NET_ADMIN` requirement instead. `INTERFACE` no longer needs to be defined as in bridge mode, it will use the container's eth0 interface by default. +* **19.12.18:** Bump to version 2.6.1. +* **10.07.18:** Bump to version 2.5.2. +* **23.03.18:** Bump to version 2.5. +* **14.12.17:** Consolidate layers and fix continuation lines. +* **25.10.17:** Bump to version 2.1.12. +* **18.08.17:** Switch default authentication method to local, update readme on how to deactivate the admin user +* **31.07.17:** Fix updates of existing openvpn-as installs. +* **07.07.17:** Bump to version 2.1.9. +* **31.10.16:** Bump to version 2.1.4. +* **14.10.16:** Add version layer information. +* **13.09.16:** Rebuild due to push error to hub on last build. +* **10.09.16:** Add layer badges to README. +* **28.08.16:** Add badges to README. +* **01.08.16:** Rebase to xenial. +* **18.09.15:** Initial Release. -+ **07.02.19:** Rebase to bionic, add pipeline logic. -+ **31.01.19:** Add port mappings to docker create sample in readme. -+ **26.01.19:** Removed `privileged` and `host` networking requirements, added `cap-add=NET_ADMIN` requirement instead. `INTERFACE` no longer needs to be defined as in bridge mode, it will use the container's eth0 interface by default. -+ **19.12.18:** Bump to version 2.6.1. -+ **10.07.18:** Bump to version 2.5.2. -+ **23.03.18:** Bump to version 2.5. -+ **14.12.17:** Consolidate layers and fix continuation lines. -+ **25.10.17:** Bump to version 2.1.12. -+ **18.08.17:** Switch default authentication method to local, update readme on how to deactivate the admin user -+ **31.07.17:** Fix updates of existing openvpn-as installs. -+ **07.07.17:** Bump to version 2.1.9. -+ **31.10.16:** Bump to version 2.1.4. -+ **14.10.16:** Add version layer information. -+ **13.09.16:** Rebuild due to push error to hub on last build. -+ **10.09.16:** Add layer badges to README. -+ **28.08.16:** Add badges to README. -+ **01.08.16:** Rebase to xenial. -+ **18.09.15:** Initial Release. diff --git a/images/docker-organizr.md b/images/docker-organizr.md old mode 100755 new mode 100644 index d2d2a5b0b..a28412178 --- a/images/docker-organizr.md +++ b/images/docker-organizr.md @@ -1,47 +1,34 @@ -# [linuxserver/organizr](https://github.com/linuxserver/docker-organizr) +# linuxserver/organizr -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/organizr.svg)](https://microbadger.com/images/linuxserver/organizr "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/organizr.svg)](https://microbadger.com/images/linuxserver/organizr "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/organizr.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/organizr.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-organizr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-organizr/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/organizr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/organizr/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/organizr.svg)](https://microbadger.com/images/linuxserver/organizr) [![](https://images.microbadger.com/badges/image/linuxserver/organizr.svg)](https://microbadger.com/images/linuxserver/organizr) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/organizr.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/organizr.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-organizr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-organizr/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/organizr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/organizr/latest/index.html) [Organizr](https://github.com/causefx/Organizr) is a HTPC/Homelab Services Organizer - Written in PHP -Do you have quite a bit of services running on your computer or server? -Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? -Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. -You can then work on your server with ease. You can even open up two tabs side by side. -Want to give users access to some Tabs? No problem, just enable user support and have them make an account. -Want guests to be able to visit too? Enable Guest support for those tabs. - -For more information on Organizr and information on how to use it visit their site at https://github.com/causefx/Organizr +Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. You can even open up two tabs side by side. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs. +For more information on Organizr and information on how to use it visit their site at [https://github.com/causefx/Organizr](https://github.com/causefx/Organizr) ## 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/). +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/). Simply pulling `linuxserver/organizr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=organizr \ -e PUID=1000 \ @@ -53,7 +40,6 @@ docker create \ linuxserver/organizr ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,40 +64,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 `:` 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 `:` 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` | will map the container's port 80 to port 9983 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 | | `TZ=` | for specifying your timezone | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | this is where your user data and logs will live | - - ## 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) ``` @@ -122,8 +105,6 @@ Dead simple to get running, create the container as instructed and start it. Whe Leave the path as default and set your timezone - you're done! - - ## Support Info * Shell access whilst the container is running: @@ -147,3 +128,4 @@ Leave the path as default and set your timezone - you're done! * **02.05.17:** - Added php7-curl package * **12.04.17:** - Added php7-ldap package * **10.03.18:** - Initial Release. + diff --git a/images/docker-photoshow.md b/images/docker-photoshow.md old mode 100755 new mode 100644 index a1b2593da..b0a99500a --- a/images/docker-photoshow.md +++ b/images/docker-photoshow.md @@ -1,37 +1,30 @@ -# [linuxserver/photoshow](https://github.com/linuxserver/docker-photoshow) +# linuxserver/photoshow -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/photoshow.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/photoshow.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-photoshow/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-photoshow/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow) [![](https://images.microbadger.com/badges/image/linuxserver/photoshow.svg)](https://microbadger.com/images/linuxserver/photoshow) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/photoshow.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/photoshow.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-photoshow/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-photoshow/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/photoshow/latest/index.html) [Photoshow](https://github.com/thibaud-rohmer/PhotoShow) is gallery software at its easiest, it doesn't even require a database. ## 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/). +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/). Simply pulling `linuxserver/photoshow` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=photoshow \ -e PUID=1000 \ @@ -45,7 +38,6 @@ docker create \ linuxserver/photoshow ``` - ### 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 `:` 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 `:` 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. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Stores config and logs for nginx base. | | `/Pictures:ro` | Your local folder of photos you wish to share. | | `/Thumbs` | Local folder to store thumbnails of your images. | - - ## 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,8 +105,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel On first run create an admin account, any folder and its subfolders that you map to /Pictures will be presented as a webgallery. Config settings are persistent and stored as a subfolder of the /Thumbs mapping. - - ## Support Info * Shell access whilst the container is running: @@ -143,3 +130,4 @@ On first run create an admin account, any folder and its subfolders that you map * **11.09.16:** - Add layer badges to README. * **21.08.15:** - Use patched keybaord js from fork of photoshow. * **21.08.15:** - Initial Release. + diff --git a/images/docker-piwigo.md b/images/docker-piwigo.md old mode 100755 new mode 100644 index f3489bde2..d3c1c532a --- a/images/docker-piwigo.md +++ b/images/docker-piwigo.md @@ -1,37 +1,30 @@ -# [linuxserver/piwigo](https://github.com/linuxserver/docker-piwigo) +# linuxserver/piwigo -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/piwigo.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/piwigo.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-piwigo/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-piwigo/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo) [![](https://images.microbadger.com/badges/image/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/piwigo.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/piwigo.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-piwigo/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-piwigo/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/index.html) [Piwigo](http://piwigo.org/) is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures. ## 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/). +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/). Simply pulling `linuxserver/piwigo` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=piwigo \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/piwigo ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,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 `:` 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 `:` 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` | 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. | - - ## 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) ``` @@ -110,11 +99,10 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * You must create a user and database for piwigo to use in a mysql/mariadb server. * In the setup page for database, use the ip address rather than hostname. -* A basic nginx configuration file can be found in `/config/nginx/site-confs`, edit the file to enable ssl (port 443 by default), set servername etc. +* A basic nginx configuration file can be found in `/config/nginx/site-confs`, edit the file to enable ssl \(port 443 by default\), set servername etc. * 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. * The easiest way to edit the configuration file is to enable local files editor from the plugins page and use it to configure email settings etc. - ## Support Info * Shell access whilst the container is running: @@ -139,3 +127,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **14.10.16:** - Add version layer information. * **10.09.16:** - Add layer badges to README. * **29.08.15:** - Initial Release. + diff --git a/images/docker-plex.md b/images/docker-plex.md old mode 100755 new mode 100644 index eee1d7861..b7c37e3d8 --- a/images/docker-plex.md +++ b/images/docker-plex.md @@ -1,37 +1,30 @@ -# [linuxserver/plex](https://github.com/linuxserver/docker-plex) +# linuxserver/plex -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/plex.svg)](https://microbadger.com/images/linuxserver/plex "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/plex.svg)](https://microbadger.com/images/linuxserver/plex "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/plex.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/plex.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-plex/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-plex/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/plex/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/plex/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/plex.svg)](https://microbadger.com/images/linuxserver/plex) [![](https://images.microbadger.com/badges/image/linuxserver/plex.svg)](https://microbadger.com/images/linuxserver/plex) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/plex.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/plex.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-plex/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-plex/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/plex/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/plex/latest/index.html) [Plex](https://plex.tv) organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. has always been a top priority. Straightforward design and bulk actions mean getting things done faster. ## 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/). +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/). Simply pulling `linuxserver/plex` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=plex \ --net=host \ @@ -46,7 +39,6 @@ docker create \ linuxserver/plex ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -73,41 +65,42 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | + + +#### Networking \(`--net`\) -#### Networking (`--net`) | Parameter | Function | -| :-----: | --- | +| :---: | :--- | | `--net=host` | Use Host Networking | -### Environment Variables (`-e`) +### Environment Variables \(`-e`\) | Env | Function | -| :----: | --- | +| :---: | :--- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `VERSION=docker` | Set whether to update plex or not - see Application Setup section. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | -| `/config` | Plex library location. *This can grow very large, 50gb+ is likely for a large collection.* | +| :---: | :--- | +| `/config` | Plex library location. _This can grow very large, 50gb+ is likely for a large collection._ | | `/data/tvshows` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. | | `/data/movies` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. | -| `/transcode` | Path for transcoding folder, *optional*. | - +| `/transcode` | Path for transcoding folder, _optional_. | ## Optional Parameters -*Special note* - If you'd like to run Plex without requiring `--net=host` (`NOT recommended`) then you will need the following ports in your `docker create` command: +_Special note_ - If you'd like to run Plex without requiring `--net=host` \(`NOT recommended`\) then you will need the following ports in your `docker create` command: -``` +```text -p 32400:32400 \ -p 32400:32400/udp \ -p 32469:32469 \ @@ -119,21 +112,19 @@ Docker images are configured using parameters passed at runtime (such as those a The application accepts a series of environment variables to further customize itself on boot: | Parameter | Function | -| :---: | --- | -| `-v /transcode` | Path for transcoding folder| -| `--device=/dev/dri:/dev/dri` | Add this option to your run command if you plan on using Quicksync hardware acceleration - see Application Setup section.| - - +| :---: | :--- | +| `-v /transcode` | Path for transcoding folder | +| `--device=/dev/dri:/dev/dri` | Add this option to your run command if you plan on using Quicksync hardware acceleration - see Application Setup section. | ## 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) ``` @@ -142,32 +133,30 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Webui can be found at `:32400/web` -** Note about updates, if there is no value set for the VERSION variable, then no updates will take place.** + **Note about updates, if there is no value set for the VERSION variable, then no updates will take place.** -** For new users, no updates will take place on the first run of the container as there is no preferences file to read your token from, to update restart the Docker container after logging in through the webui** + **For new users, no updates will take place on the first run of the container as there is no preferences file to read your token from, to update restart the Docker container after logging in through the webui** Valid settings for VERSION are:- `IMPORTANT NOTE:- YOU CANNOT UPDATE TO A PLEXPASS ONLY (BETA) VERSION IF YOU ARE NOT LOGGED IN WITH A PLEXPASS ACCOUNT` -+ **`docker`**: Let Docker handle the Plex Version, we keep our Dockerhub Endpoint up to date with the latest public builds. This is the same as leaving this setting out of your create command. -+ **`latest`**: will update plex to the latest version available that you are entitled to. -+ **`public`**: will update plexpass users to the latest public version, useful for plexpass users that don't want to be on the bleeding edge but still want the latest public updates. -+ **``**: will select a specific version (eg 0.9.12.4.1192-9a47d21) of plex to install, note you cannot use this to access plexpass versions if you do not have plexpass. +* `docker`: Let Docker handle the Plex Version, we keep our Dockerhub Endpoint up to date with the latest public builds. This is the same as leaving this setting out of your create command. +* `latest`: will update plex to the latest version available that you are entitled to. +* `public`: will update plexpass users to the latest public version, useful for plexpass users that don't want to be on the bleeding edge but still want the latest public updates. +* ``: will select a specific version \(eg 0.9.12.4.1192-9a47d21\) of plex to install, note you cannot use this to access plexpass versions if you do not have plexpass. Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container: -```--device=/dev/dri:/dev/dri``` +`--device=/dev/dri:/dev/dri` We will automatically ensure the abc user inside of the container has the proper permissions to access this device. Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: -https://github.com/NVIDIA/nvidia-docker - -We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the plex docker. - +[https://github.com/NVIDIA/nvidia-docker](https://github.com/NVIDIA/nvidia-docker) +We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` \(can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` \). NVIDIA automatically mounts the GPU and drivers from your host into the plex docker. ## Support Info @@ -182,7 +171,7 @@ We automatically add the necessary environment variable that will utilise all th ## Versions -* **14.03.19:** - Switch to new api endpoints, enable beta (plex pass) updates for armhf and aarch64. +* **14.03.19:** - Switch to new api endpoints, enable beta \(plex pass\) updates for armhf and aarch64. * **15.02.19:** - Clean up plex pid after unclean stop. * **11.02.19:** - Fix nvidia variables, add device variables. * **16.01.19:** - Add pipeline logic, multi arch, and HW transcoding configuration; remove avahi service. @@ -197,12 +186,13 @@ We automatically add the necessary environment variable that will utilise all th * **09.09.16:** - Add layer badges to README. * **27.08.16:** - Add badges to README. * **22.08.16:** - Rebased to xenial and s6 overlay -* **07.04.16:** - removed `/transcode` volume support (upstream Plex change) and modified PlexPass download method to prevent unauthorised usage of paid PMS -* **24.09.15:** - added optional support for volume transcoding (/transcode), and various typo fixes. +* **07.04.16:** - removed `/transcode` volume support \(upstream Plex change\) and modified PlexPass download method to prevent unauthorised usage of paid PMS +* **24.09.15:** - added optional support for volume transcoding \(/transcode\), and various typo fixes. * **17.09.15:** - Changed to run chmod only once * **19.09.15:** - Plex updated their download servers from http to https * **28.08.15:** - Removed plexpass from routine, and now uses VERSION as a combination fix. * **18.07.15:** - Moved autoupdate to be hosted by linuxserver.io and implemented bugfix thanks to ljm42. * **09.07.15:** - Now with ability to pick static version number. -* **08.07.15:** - Now with autoupdates. (Hosted by fanart.tv) -* **03.07.15:** - Fixed a mistake that allowed plex to run as user plex rather than abc (99:100). Thanks to double16 for spotting this. +* **08.07.15:** - Now with autoupdates. \(Hosted by fanart.tv\) +* **03.07.15:** - Fixed a mistake that allowed plex to run as user plex rather than abc \(99:100\). Thanks to double16 for spotting this. + diff --git a/images/docker-qbittorrent.md b/images/docker-qbittorrent.md old mode 100755 new mode 100644 index 075468c16..c6226d33f --- a/images/docker-qbittorrent.md +++ b/images/docker-qbittorrent.md @@ -1,37 +1,30 @@ -# [linuxserver/qbittorrent](https://github.com/linuxserver/docker-qbittorrent) +# linuxserver/qbittorrent -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/qbittorrent.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/qbittorrent.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-qbittorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-qbittorrent/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent) [![](https://images.microbadger.com/badges/image/linuxserver/qbittorrent.svg)](https://microbadger.com/images/linuxserver/qbittorrent) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/qbittorrent.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/qbittorrent.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-qbittorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-qbittorrent/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/qbittorrent/latest/index.html) The [Qbittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library. ## 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/). +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/). Simply pulling `linuxserver/qbittorrent` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=qbittorrent \ -e PUID=1000 \ @@ -47,7 +40,6 @@ docker create \ linuxserver/qbittorrent ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -76,75 +68,69 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `6881` | tcp connection port | | `6881/udp` | udp connection port | | `8080` | http gui | - -### 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 | | `UMASK_SET=022` | for umask setting of qbittorrent, optional , default if left unset is 022 | | `WEBUI_PORT=8080` | for changing the port of the webui, see below for explanation | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Contains all relevant 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) ``` ## Application Setup -The webui is at `:8080` and the default username/password is `admin/adminadmin`. +The webui is at `:8080` and the default username/password is `admin/adminadmin`. -Change username/password via the webui in the webui section of settings. +Change username/password via the webui in the webui section of settings. +### WEBUI\_PORT variable -### WEBUI_PORT variable +Due to issues with CSRF and port mapping, should you require to alter the port for the webui you need to change both sides of the -p 8080 switch AND set the WEBUI\_PORT variable to the new port. -Due to issues with CSRF and port mapping, should you require to alter the port for the webui you need to change both sides of the -p 8080 switch AND set the WEBUI_PORT variable to the new port. +For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI\_PORT=8090 -For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI_PORT=8090 +This should alleviate the "white screen" issue. -This should alleviate the "white screen" issue. +If you have no webui , check the file /config/qBittorrent/qBittorrent.conf -If you have no webui , check the file /config/qBittorrent/qBittorrent.conf +edit or add the following lines -edit or add the following lines - -``` +```text WebUI\Address=* WebUI\ServerDomains=* ``` - - ## Support Info * Shell access whilst the container is running: @@ -164,11 +150,12 @@ WebUI\ServerDomains=* * **08.06.18:** - Bump qbitorrent to 4.1.1. * **26.04.18:** - Bump libtorrent to 1.1.7. * **02.03.18:** - Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6. -* **02.01.18:** - Deprecate cpu_core routine lack of scaling. +* **02.01.18:** - Deprecate cpu\_core routine lack of scaling. * **19.12.17:** - Update to v4.0.3. * **09.02.17:** - Rebase to alpine 3.7 * **01.12.17:** - Update to v4.0.2. -* **27.11.17:** - Update to v4 and use cpu_core routine to speed up builds. -* **16.09.17:** - Bump to 3.3.16, Add WEBUI_PORT variable and notes to README to allow changing port of webui. +* **27.11.17:** - Update to v4 and use cpu\_core routine to speed up builds. +* **16.09.17:** - Bump to 3.3.16, Add WEBUI\_PORT variable and notes to README to allow changing port of webui. * **01.08.17:** - Initial Release. * **12.02.18:** - Initial Release. + diff --git a/images/docker-quassel-core.md b/images/docker-quassel-core.md old mode 100755 new mode 100644 index 054adf668..a18320737 --- a/images/docker-quassel-core.md +++ b/images/docker-quassel-core.md @@ -1,40 +1,32 @@ -# [linuxserver/quassel-core](https://github.com/linuxserver/docker-quassel-core) +# linuxserver/quassel-core -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-core.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-core.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-quassel-core/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-quassel-core/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-core/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-core/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core) [![](https://images.microbadger.com/badges/image/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-core.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-core.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-quassel-core/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-quassel-core/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-core/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-core/latest/index.html) -[Quassel-core](http://quassel-irc.org/) is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core. - -This container handles the IRC connection (quasselcore) and requires a desktop client (quasselclient) to be used and configured. It is designed to be always on and will keep your identity present in IRC even when your clients cannot be online. Backlog (history) is downloaded by your client upon reconnection allowing infinite scrollback through time. +[Quassel-core](http://quassel-irc.org/) is a modern, cross-platform, distributed IRC client, meaning that one \(or multiple\) client\(s\) can attach to and detach from a central core. +This container handles the IRC connection \(quasselcore\) and requires a desktop client \(quasselclient\) to be used and configured. It is designed to be always on and will keep your identity present in IRC even when your clients cannot be online. Backlog \(history\) is downloaded by your client upon reconnection allowing infinite scrollback through time. ## 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/). +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/). Simply pulling `linuxserver/quassel-core` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=quassel-core \ -e PUID=1000 \ @@ -46,7 +38,6 @@ docker create \ linuxserver/quassel-core ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -71,40 +62,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `4242` | The port quassel-core listens for connections on. | - -### 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` | Database and quassel-core configuration storage. | - - ## 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) ``` @@ -113,13 +101,11 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Quassel wiki: [quassel](http://bugs.quassel-irc.org/projects/quassel-irc/wiki) -A great place to host a quassel instance is a VPS, such as [DigitalOcean](https://www.digitalocean.com/?refcode=501c48b34b8c). For $5 a month you can have a 24/7 IRC connection and be up and running in under 55 seconds (or so they claim). - -Once you have the container running, fire up a quassel desktop client and connect to your new core instance using your droplets public IP address and the port you specified in your `docker run` command *default: 4242*. Create an admin user, select SQLite as your storage backend (Quassel limitation). Setup your real name and nick, then press `Save & Connect`. - -You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.io/index.php/irc/) `#linuxserver.io` room on Freenode. Click 'File' > 'Networks' > 'Configure Networks' > 'Add' (under Networks section, not Servers) > 'Use preset' > Select 'Freenode' and then configure your identity using the tabs in the 'Network details' section. Once connected to Freenode, click `#join` and enter `#linuxserver.io`. That's it, you're done. +A great place to host a quassel instance is a VPS, such as [DigitalOcean](https://www.digitalocean.com/?refcode=501c48b34b8c). For $5 a month you can have a 24/7 IRC connection and be up and running in under 55 seconds \(or so they claim\). +Once you have the container running, fire up a quassel desktop client and connect to your new core instance using your droplets public IP address and the port you specified in your `docker run` command _default: 4242_. Create an admin user, select SQLite as your storage backend \(Quassel limitation\). Setup your real name and nick, then press `Save & Connect`. +You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.io/index.php/irc/) `#linuxserver.io` room on Freenode. Click 'File' > 'Networks' > 'Configure Networks' > 'Add' \(under Networks section, not Servers\) > 'Use preset' > Select 'Freenode' and then configure your identity using the tabs in the 'Network details' section. Once connected to Freenode, click `#join` and enter `#linuxserver.io`. That's it, you're done. ## Support Info @@ -137,7 +123,7 @@ You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.i * **26.01.19:** - Add pipeline logic and multi arch. * **08.01.19:** - Rebase to Ubuntu Bionic and upgrade to Quassel`0.13.0` See [here.](https://quassel-irc.org/node/134). * **30.07.18:** - Rebase to alpine:3.8 and use buildstage. -* **03.01.18:** - Deprecate cpu_core routine lack of scaling. +* **03.01.18:** - Deprecate cpu\_core routine lack of scaling. * **09.12.17:** - Rebase to alpine:3.7. * **26.11.17:** - Use cpu core counting routine to speed up build time. * **12.07.17:** - Add inspect commands to README, move to jenkins build and push. @@ -145,11 +131,12 @@ You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.i * **13.05.17:** - Switch to git source. * **28.12.16:** - Rebase to alpine:3.5. * **23.11.16:** - Rebase to alpine:edge. -* **23.09.16:** - Use QT5 dependencies (thanks bauerj). +* **23.09.16:** - Use QT5 dependencies \(thanks bauerj\). * **10.09.16:** - Add layer badges to README. * **28.08.16:** - Add badges to README. * **10.08.16:** - Rebase to xenial. * **14.10.15:** - Removed the webui, turned out to be to unstable for most usecases. * **01.09.15:** - Fixed mistake in README. * **30.07.15:** - Switched to internal baseimage, and fixed a bug with updating the webinterface. -* **06.07.15:** - Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client. +* **06.07.15:** - Enabled BLOWFISH encryption and added a \(optional\) webinterface, for the times you dont have access to your client. + diff --git a/images/docker-radarr.md b/images/docker-radarr.md old mode 100755 new mode 100644 index f92912179..dc8500c79 --- a/images/docker-radarr.md +++ b/images/docker-radarr.md @@ -1,38 +1,30 @@ -# [linuxserver/radarr](https://github.com/linuxserver/docker-radarr) +# linuxserver/radarr -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/radarr.svg)](https://microbadger.com/images/linuxserver/radarr "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/radarr.svg)](https://microbadger.com/images/linuxserver/radarr "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-radarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/radarr.svg)](https://microbadger.com/images/linuxserver/radarr) [![](https://images.microbadger.com/badges/image/linuxserver/radarr.svg)](https://microbadger.com/images/linuxserver/radarr) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-radarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/index.html) [Radarr](https://github.com/Radarr/Radarr) - A fork of Sonarr to work with movies à la Couchpotato. - ## 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/). +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/). Simply pulling `linuxserver/radarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=radarr \ -e PUID=1000 \ @@ -48,13 +40,12 @@ docker create \ You can choose between ,using tags, various branch versions of radarr, no tag is required to remain on the main branch. -Add one of the tags, if required, to the linuxserver/radarr line of the run/create command in the following format, linuxserver/radarr:nightly +Add one of the tags, if required, to the linuxserver/radarr line of the run/create command in the following format, linuxserver/radarr:nightly The nightly branch and master branch can from time to time be the same version. HOWEVER , USE THE NIGHTLY BRANCH AT YOUR OWN PERIL !!!!!!!!! - ### docker-compose Compatible with docker-compose v2 schemas. @@ -81,42 +72,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `7878` | The port for the Radarr 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 EG Europe/London, this is required for Radarr | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Database and Radarr configs | | `/movies` | Location of Movie library on disk | | `/downloads` | Location of download managers output 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) ``` @@ -125,8 +113,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:7878`, for more information check out [Radarr](https://github.com/Radarr/Radarr). - - ## Support Info * Shell access whilst the container is running: @@ -147,3 +133,4 @@ Access the webui at `:7878`, for more information check out [Radarr](ht * **17.04.17:** - Switch to using inhouse mono baseimage, adds python also. * **13.04.17:** - Switch to official mono repository. * **10.01.17:** - Initial Release. + diff --git a/images/docker-rutorrent.md b/images/docker-rutorrent.md index 9768ccd5e..251920717 100644 --- a/images/docker-rutorrent.md +++ b/images/docker-rutorrent.md @@ -1,37 +1,30 @@ -# [linuxserver/rutorrent](https://github.com/linuxserver/docker-rutorrent) +# linuxserver/rutorrent -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/rutorrent.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-rutorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent) [![](https://images.microbadger.com/badges/image/linuxserver/rutorrent.svg)](https://microbadger.com/images/linuxserver/rutorrent) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/rutorrent.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/rutorrent.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-rutorrent/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-rutorrent/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/rutorrent/latest/index.html) [Rutorrent](https://github.com/Novik/ruTorrent) is a popular rtorrent client with a webui for ease of use. ## 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/). +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/). Simply pulling `linuxserver/rutorrent` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=rutorrent \ -e PUID=1000 \ @@ -46,7 +39,6 @@ docker create \ linuxserver/rutorrent ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -74,43 +66,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 `:` 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 `:` 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` | ruTorrent Web UI | | `5000` | scgi port | | `51413` | Bit-torrent port | | `6881/udp` | Bit-torrent 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 | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | where ruTorrent should store it's config files | | `/downloads` | path to your downloads folder | - - ## 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) ``` @@ -121,32 +110,28 @@ Webui can be found at `:80` , configuration files for rtorrent are in / `Settings, changed by the user through the "Settings" panel in ruTorrent, are valid until rtorrent restart. After which all settings will be set according to the rtorrent config file (/config/rtorrent/rtorrent.rc),this is a limitation of the actual apps themselves.` -** Important note for unraid users or those running services such as a webserver on port 80, change port 80 assignment ** + **Important note for unraid users or those running services such as a webserver on port 80, change port 80 assignment** `** It should also be noted that this container when run will create subfolders ,completed, incoming and watched in the /downloads volume.**` -** The Port Assignments and configuration folder structure has been changed from the previous ubuntu based versions of this container and we recommend a clean install ** + **The Port Assignments and configuration folder structure has been changed from the previous ubuntu based versions of this container and we recommend a clean install** Umask can be set in the /config/rtorrent/rtorrent.rc file by changing value in `system.umask.set` If you are seeing this error `Caught internal_error: 'DhtRouter::get_tracker did not actually insert tracker.'.` , a possible fix is to disable dht in `/config/rtorrent/rtorrent.rc` by changing the following values. -```shell +```text dht = disable peer_exchange = no ``` -If after updating you see an error about connecting to rtorrent in the webui, -remove or comment out these lines in /config/rtorrent/rtorrent.rc ,whatever value is set, yes or no. -Just setting them to no will still cause the error.. +If after updating you see an error about connecting to rtorrent in the webui, remove or comment out these lines in /config/rtorrent/rtorrent.rc ,whatever value is set, yes or no. Just setting them to no will still cause the error.. -``` +```text use_udp_trackers = yes peer_exchange = yes ``` - - ## Support Info * Shell access whilst the container is running: @@ -183,3 +168,4 @@ peer_exchange = yes * **07.08.16:** - Perms fix on nginx tmp folder, also exposed php.ini for editing by use in /config/php. * **26.07.16:** - Rebase to alpine. * **08.03.16:** - Initial Release. + diff --git a/images/docker-shout-irc.md b/images/docker-shout-irc.md old mode 100755 new mode 100644 index ae8fa062e..8316a6f30 --- a/images/docker-shout-irc.md +++ b/images/docker-shout-irc.md @@ -1,37 +1,30 @@ -# [linuxserver/shout-irc](https://github.com/linuxserver/docker-shout-irc) +# linuxserver/shout-irc -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/shout-irc.svg)](https://microbadger.com/images/linuxserver/shout-irc "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/shout-irc.svg)](https://microbadger.com/images/linuxserver/shout-irc "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/shout-irc.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/shout-irc.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-shout-irc/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-shout-irc/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/shout-irc.svg)](https://microbadger.com/images/linuxserver/shout-irc) [![](https://images.microbadger.com/badges/image/linuxserver/shout-irc.svg)](https://microbadger.com/images/linuxserver/shout-irc) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/shout-irc.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/shout-irc.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-shout-irc/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-shout-irc/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/shout-irc/latest/index.html) [Shout-irc](http://shout-irc.com/) is a web IRC client that you host on your own server. ## 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/). +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/). Simply pulling `linuxserver/shout-irc` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=shout-irc \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/shout-irc ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,48 +60,44 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `9000` | 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. | - - ## 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 log in to the application, browse to https://:9000. * To setup user account(s) edit `/config/config.json` * Change the value `public: true,` to `public: false,` * restart the container and enter the following from the command line of the host: * `docker exec -it thelounge thelounge add ` * Enter a password when prompted, refresh your browser. * You should now be prompted for a password on the webinterface. - +* To log in to the application, browse to https://:9000. _To setup user account\(s\) edit_ `/config/config.json` __ Change the value `public: true,` to `public: false,` _restart the container and enter the following from the command line of the host:_ `docker exec -it thelounge thelounge add ` _Enter a password when prompted, refresh your browser._ You should now be prompted for a password on the webinterface. ## Support Info @@ -132,3 +120,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **09.02.17:** - Rebase to alpine 3.5. * **14.10.16:** - Add version layer information. * **31.08.16:** - Rebase to alpine linux, move to lsiocommunity + diff --git a/images/docker-sickgear.md b/images/docker-sickgear.md old mode 100755 new mode 100644 index 6d9903b58..fdf4e1f2d --- a/images/docker-sickgear.md +++ b/images/docker-sickgear.md @@ -1,40 +1,32 @@ -# [linuxserver/sickgear](https://github.com/linuxserver/docker-sickgear) +# linuxserver/sickgear -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickgear.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sickgear/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear) [![](https://images.microbadger.com/badges/image/linuxserver/sickgear.svg)](https://microbadger.com/images/linuxserver/sickgear) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sickgear.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sickgear.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sickgear/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sickgear/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sickgear/latest/index.html) -[SickGear](https://github.com/sickgear/sickgear) provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. - -For more information on SickGear visit their website and check it out: https://github.com/SickGear/SickGear +[SickGear](https://github.com/sickgear/sickgear) provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. +For more information on SickGear visit their website and check it out: [https://github.com/SickGear/SickGear](https://github.com/SickGear/SickGear) ## 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/). +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/). Simply pulling `linuxserver/sickgear` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=sickgear \ -e PUID=1000 \ @@ -47,7 +39,6 @@ docker create \ linuxserver/sickgear ``` - ### 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 `:` 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 `:` 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 | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | this will store any uploaded data on the docker host | | `/tv` | where you store your tv shows | -| `/downloads` | your downloads folder for post processing (must not be donwload in progress) | - - +| `/downloads` | your downloads folder for post processing \(must not be donwload in progress\) | ## 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,29 +111,18 @@ Access the webui at `:8081`, for more information check out [SickGear]( Non linuxserver.io containers are known to have the following configuration differences and may need SickGear or docker changes to migrate an existing setup * The post processing directory which is volume mounted as `downloads` within this container may be `incoming` in other versions. - * The permissions environmental variables which are defined as `PGID` and `PUID` within this container may have been `APP_UID` and `APP_UID` in other versions. - * The configuration file directory which is volume mounted as `config` within this container may be set as the environmetal variable `APP_DATA` in other versions. - -* The cache directory which is set in `config.ini` may be configured as a fixed path `cache_dir = /data/cache`. -Symptoms of this issue include port usage problems and a failure to start the web server log entries. -Whilst the container is stopped alter this directive to `cache_dir = cache` which will allow SickGear to look for the folder relative to the volume mounted `/config` directory. +* The cache directory which is set in `config.ini` may be configured as a fixed path `cache_dir = /data/cache`. Symptoms of this issue include port usage problems and a failure to start the web server log entries. Whilst the container is stopped alter this directive to `cache_dir = cache` which will allow SickGear to look for the folder relative to the volume mounted `/config` directory. It is recommended that a clean install be completed, rather than a migration, however if migration is necessary: * start a new instance of this image - * compare and align SickGear version numbers bewteen old and new. Ideally they should match but at a minumum the old vesion should be a lower version number to allow SickGear itself to try and migrate - * stop both containers - * notice the configuration difference and migrate copies of the old settings into the new app - * start the new container and test - - ## Support Info * Shell access whilst the container is running: @@ -162,3 +139,4 @@ It is recommended that a clean install be completed, rather than a migration, ho * **22.02.19:** - Rebasing to alpine 3.9. * **07.11.18:** - Pipeline prep * **07.07.18:** - Initial draft release + diff --git a/images/docker-smokeping.md b/images/docker-smokeping.md old mode 100755 new mode 100644 index 16ddd77ac..8ab2763d4 --- a/images/docker-smokeping.md +++ b/images/docker-smokeping.md @@ -1,37 +1,30 @@ -# [linuxserver/smokeping](https://github.com/linuxserver/docker-smokeping) +# linuxserver/smokeping -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/smokeping.svg)](https://microbadger.com/images/linuxserver/smokeping "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/smokeping.svg)](https://microbadger.com/images/linuxserver/smokeping "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/smokeping.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/smokeping.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-smokeping/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-smokeping/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/smokeping.svg)](https://microbadger.com/images/linuxserver/smokeping) [![](https://images.microbadger.com/badges/image/linuxserver/smokeping.svg)](https://microbadger.com/images/linuxserver/smokeping) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/smokeping.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/smokeping.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-smokeping/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-smokeping/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/smokeping/latest/index.html) [Smokeping](https://oss.oetiker.ch/smokeping/) keeps track of your network latency. For a full example of what this application is capable of visit [UCDavis](http://smokeping.ucdavis.edu/cgi-bin/smokeping.fcgi). ## 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/). +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/). Simply pulling `linuxserver/smokeping` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=smokeping \ -e PUID=1000 \ @@ -44,7 +37,6 @@ docker create \ linuxserver/smokeping ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -70,52 +62,47 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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` | Allows HTTP access to the internal webserver. | - -### 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` | Configure the `Targets` file here | -| `/data` | Storage location for db and application data (graphs etc) | - - +| `/data` | Storage location for db and application data \(graphs etc\) | ## User / Group Identifiers -When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. +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 -- Once running the URL will be `http:///`. -- Basics are, edit the `Targets` file to ping the hosts you're interested in to match the format found there. -- Wait 10 minutes. - - +* Once running the URL will be `http:///`. +* Basics are, edit the `Targets` file to ping the hosts you're interested in to match the format found there. +* Wait 10 minutes. ## Support Info @@ -134,8 +121,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **14.11.18:** - Allow access without /smokeping in URL. * **28.04.18:** - Rebase to alpine 3.8. * **09.04.18:** - Add bc package. -* **08.04.18:** - Add tccping script and tcptraceroute package (thanks rcarmo). -* **13.12.17:** - Expose httpd_conf to /config. +* **08.04.18:** - Add tccping script and tcptraceroute package \(thanks rcarmo\). +* **13.12.17:** - Expose httpd\_conf to /config. * **13.12.17:** - Rebase to alpine 3.7. * **24.07.17:** - Add :unraid tag for hosts without ipv6. * **12.07.17:** - Add inspect commands to README, move to jenkins build and push. @@ -149,4 +136,5 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **28.08.16:** - Add badges to README. * **25.07.16:** - Rebase to alpine linux. * **23.07.16:** - Fix apt script confusion. -* **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. (thus a beta tag) +* **29.06.15:** - This is the first release, it is mostly stable, but may contain minor defects. \(thus a beta tag\) + diff --git a/images/docker-snipe-it.md b/images/docker-snipe-it.md old mode 100755 new mode 100644 index 5dee668c9..a429f74fc --- a/images/docker-snipe-it.md +++ b/images/docker-snipe-it.md @@ -1,37 +1,30 @@ -# [linuxserver/snipe-it](https://github.com/linuxserver/docker-snipe-it) +# linuxserver/snipe-it -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/snipe-it.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/snipe-it.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-snipe-it/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-snipe-it/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/snipe-it/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/snipe-it/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it) [![](https://images.microbadger.com/badges/image/linuxserver/snipe-it.svg)](https://microbadger.com/images/linuxserver/snipe-it) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/snipe-it.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/snipe-it.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-snipe-it/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-snipe-it/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/snipe-it/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/snipe-it/latest/index.html) [Snipe-it](https://github.com/snipe/snipe-it) makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster. ## 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/). +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/). Simply pulling `linuxserver/snipe-it` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=snipe-it \ -e PUID=1000 \ @@ -48,7 +41,6 @@ docker create \ linuxserver/snipe-it ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -86,80 +78,77 @@ services: - PUID=1000 ports: - "8080:80" - ``` ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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` | Snipe-IT Web UI | - -### Environment Variables (`-e`) +### Environment Variables \(`-e`\) | Env | Function | -| :----: | --- | +| :---: | :--- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `APP_URL=` | Hostname or IP and port if applicable IE :8080 | +| `APP_URL=` | Hostname or IP and port if applicable IE :8080 | | `MYSQL_PORT_3306_TCP_ADDR=` | Mysql hostname or IP to use | | `MYSQL_PORT_3306_TCP_PORT=` | Mysql port to use | | `MYSQL_DATABASE=` | Mysql database to use | | `MYSQL_USER=` | Mysql user to use | | `MYSQL_PASSWORD=changeme` | Mysql password to use | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Contains your config files and data storage for Snipe-IT | - ## Optional Parameters This container also generates an SSL certificate and stores it in -``` + +```text /config/keys/cert.crt /config/keys/key.crt ``` + To use your own certificate swap these files with yours. To use SSL forward your port to 443 inside the container IE: -``` +```text -p 443:443 ``` The application accepts a series of environment variables to further customize itself on boot: | Parameter | Function | -| :---: | --- | -| `-e APP_TIMEZONE=` | The timezone the application will use IE US/Pacific| -| `-e APP_ENV=` | Default is production but can use testing or develop| -| `-e APP_DEBUG=` | Set to true to see debugging output in the web UI| -| `-e APP_LOCALE=` | Default is en set to the language preferred full list [here][localesurl]| -| `-e MAIL_PORT_587_TCP_ADDR=` | SMTP mailserver ip or hostname| -| `-e MAIL_PORT_587_TCP_PORT=` | SMTP mailserver port| -| `-e MAIL_ENV_FROM_ADDR=` | The email address mail should be replied to and listed when sent| -| `-e MAIL_ENV_FROM_NAME=` | The name listed on email sent from the default account on the system| +| :---: | :--- | +| `-e APP_TIMEZONE=` | The timezone the application will use IE US/Pacific | +| `-e APP_ENV=` | Default is production but can use testing or develop | +| `-e APP_DEBUG=` | Set to true to see debugging output in the web UI | +| `-e APP_LOCALE=` | Default is en set to the language preferred full list \[here\]\[localesurl\] | +| `-e MAIL_PORT_587_TCP_ADDR=` | SMTP mailserver ip or hostname | +| `-e MAIL_PORT_587_TCP_PORT=` | SMTP mailserver port | +| `-e MAIL_ENV_FROM_ADDR=` | The email address mail should be replied to and listed when sent | +| `-e MAIL_ENV_FROM_NAME=` | The name listed on email sent from the default account on the system | | `-e MAIL_ENV_ENCRYPTION=` | Mail encryption to use IE tls | -| `-e MAIL_ENV_USERNAME=` | SMTP server login username| -| `-e MAIL_ENV_PASSWORD=` | SMTP server login password| - - +| `-e MAIL_ENV_USERNAME=` | SMTP server login username | +| `-e MAIL_ENV_PASSWORD=` | SMTP server login password | ## 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) ``` @@ -168,8 +157,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:8080`, for more information check out [Snipe-it](https://github.com/snipe/snipe-it). - - ## Support Info * Shell access whilst the container is running: @@ -187,3 +174,4 @@ Access the webui at `:8080`, for more information check out [Snipe-it]( * **31.10.18:** - Rebasing to alpine 3.8 * **05.08.18:** - Migration to live build server. * **13.06.18:** - Initial Release. + diff --git a/images/docker-sonarr.md b/images/docker-sonarr.md old mode 100755 new mode 100644 index 0c2ebdb67..3a5ab6d72 --- a/images/docker-sonarr.md +++ b/images/docker-sonarr.md @@ -1,38 +1,30 @@ -# [linuxserver/sonarr](https://github.com/linuxserver/docker-sonarr) +# linuxserver/sonarr -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/sonarr.svg)](https://microbadger.com/images/linuxserver/sonarr "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/sonarr.svg)](https://microbadger.com/images/linuxserver/sonarr "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sonarr.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sonarr.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sonarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sonarr/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sonarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sonarr/latest/index.html) - -[Sonarr](https://sonarr.tv/) (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows 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. +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/sonarr.svg)](https://microbadger.com/images/linuxserver/sonarr) [![](https://images.microbadger.com/badges/image/linuxserver/sonarr.svg)](https://microbadger.com/images/linuxserver/sonarr) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/sonarr.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/sonarr.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-sonarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-sonarr/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sonarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/sonarr/latest/index.html) +[Sonarr](https://sonarr.tv/) \(formerly NZBdrone\) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows 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. ## 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/). +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/). Simply pulling `linuxserver/sonarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=sonarr \ -e PUID=1000 \ @@ -51,11 +43,10 @@ docker create \ 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 builds from the master branch of sonarr (currently v2) | -| develop | development builds from the develop branch of sonarr (currently v2) | -| preview | preview builds from the phantom-develop branch of sonarr (currently v3) | - +| :---: | :--- | +| latest | stable builds from the master branch of sonarr \(currently v2\) | +| develop | development builds from the develop branch of sonarr \(currently v2\) | +| preview | preview builds from the phantom-develop branch of sonarr \(currently v3\) | ### docker-compose @@ -83,42 +74,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8989` | The port for the Sonarr 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 EG Europe/London, this is required for Sonarr | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Database and sonarr configs | | `/tv` | Location of TV library on disk | | `/downloads` | Location of download managers output 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) ``` @@ -127,8 +115,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:8989`, for more information check out [Sonarr](https://sonarr.tv/). - - ## Support Info * Shell access whilst the container is running: @@ -149,9 +135,10 @@ Access the webui at `:8989`, for more information check out [Sonarr](ht * **14.04.17:** - Change to mount /etc/localtime in README, thanks cbgj. * **13.04.17:** - Switch to official mono repository. * **30.09.16:** - Fix umask -* **23.09.16:** - Add cd to /opt fixes redirects with althub (issue #25) , make XDG config environment variable +* **23.09.16:** - Add cd to /opt fixes redirects with althub \(issue \#25\) , make XDG config environment variable * **15.09.16:** - Add libcurl3 package. * **09.09.16:** - Add layer badges to README. * **27.08.16:** - Add badges to README. * **20.07.16:** - Rebase to xenial. * **31.08.15:** - Cleanup, changed sources to fetch binarys from. also a new baseimage. + diff --git a/images/docker-syncthing.md b/images/docker-syncthing.md index a4ec32909..8d80480b4 100644 --- a/images/docker-syncthing.md +++ b/images/docker-syncthing.md @@ -1,37 +1,30 @@ -# [linuxserver/syncthing](https://github.com/linuxserver/docker-syncthing) +# linuxserver/syncthing -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-syncthing/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing) [![](https://images.microbadger.com/badges/image/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-syncthing/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/index.html) [Syncthing](https://syncthing.net) replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet. ## 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/). +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/). Simply pulling `linuxserver/syncthing` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=syncthing \ -e PUID=1000 \ @@ -48,7 +41,6 @@ docker create \ linuxserver/syncthing ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,53 +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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8384` | Application WebUI | | `22000` | Listening port | | `21027/udp` | Protocol discovery | - -### 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. | | `UMASK_SET=<022>` | Umask setting - [explaination](https://askubuntu.com/questions/44542/what-is-umask-and-how-does-it-work) | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Configuration files. | | `/data1` | Data1 | | `/data2` | Data2 | - - ## 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 -**Note: ** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to `Actions -> Settings -> set user/password` for the webUI. - +**Note:** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to `Actions -> Settings -> set user/password` for the webUI. ## Support Info @@ -145,7 +133,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **30.07.18:** - Rebase to alpine 3.8 and use buildstage. * **13.12.17:** - Rebase to alpine 3.7. * **25.10.17:** - Add env for manual setting of umask. -* **29.07.17:** - Simplify build structure as symlinks failing on > 0.14.32 +* **29.07.17:** - Simplify build structure as symlinks failing on > 0.14.32 * **28.05.17:** - Rebase to alpine 3.6. * **08.02.17:** - Rebase to alpine 3.5. * **01.11.16:** - Switch to compiling latest version from git source. @@ -154,5 +142,6 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **09.09.16:** - Add layer badges to README. * **28.08.16:** - Add badges to README. * **11.08.16:** - Rebase to alpine linux. -* **18.12.15:** - Initial testing / release (IronicBadger) -* **24.09.15:** - Inital dev complete (Lonix) +* **18.12.15:** - Initial testing / release \(IronicBadger\) +* **24.09.15:** - Inital dev complete \(Lonix\) + diff --git a/images/docker-tautulli.md b/images/docker-tautulli.md old mode 100755 new mode 100644 index 2148bf33d..a20dce205 --- a/images/docker-tautulli.md +++ b/images/docker-tautulli.md @@ -1,25 +1,19 @@ -# [linuxserver/tautulli](https://github.com/linuxserver/docker-tautulli) +# linuxserver/tautulli -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tautulli.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tautulli.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tautulli/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tautulli/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tautulli/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tautulli/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli) [![](https://images.microbadger.com/badges/image/linuxserver/tautulli.svg)](https://microbadger.com/images/linuxserver/tautulli) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tautulli.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tautulli.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tautulli/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tautulli/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tautulli/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tautulli/latest/index.html) [Tautulli](http://tautulli.com) is a python based web application for monitoring, analytics and notifications for Plex Media Server. ## 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/). +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/). Simply pulling `linuxserver/tautulli` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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 Tautulli releases | | develop | Built at head of Tautulli nightly branch | @@ -39,7 +33,7 @@ Here are some example snippets to help you get started creating a container from ### docker -``` +```text docker create \ --name=tautulli \ -e PUID=1000 \ @@ -52,7 +46,6 @@ docker create \ linuxserver/tautulli ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,51 +71,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `8181` | 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` | Contains tautulli config and database. | | `/logs` | Map this to Plex log directory - recommended RO. | - - ## 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 -Access the webui at `:8181`, for more information check out [Tautulli](http://tautulli.com). -In tautulli gui settings, under `Plex Media Server`, turn on `Show Advanced` and set the `Logs Folder` to `/logs` - - +Access the webui at `:8181`, for more information check out [Tautulli](http://tautulli.com). In tautulli gui settings, under `Plex Media Server`, turn on `Show Advanced` and set the `Logs Folder` to `/logs` ## Support Info @@ -152,3 +139,4 @@ In tautulli gui settings, under `Plex Media Server`, turn on `Show Advanced` and * **27.08.16:** - Add badges to README. * **08.08.16:** - Rebase to alpine linux. * **16.07.15:** - Inital Release. + diff --git a/images/docker-thelounge.md b/images/docker-thelounge.md old mode 100755 new mode 100644 index 8999908af..06d7df11d --- a/images/docker-thelounge.md +++ b/images/docker-thelounge.md @@ -1,37 +1,30 @@ -# [linuxserver/thelounge](https://github.com/linuxserver/docker-thelounge) +# linuxserver/thelounge -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/thelounge.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/thelounge.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-thelounge/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-thelounge/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge) [![](https://images.microbadger.com/badges/image/linuxserver/thelounge.svg)](https://microbadger.com/images/linuxserver/thelounge) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/thelounge.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/thelounge.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-thelounge/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-thelounge/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/thelounge/latest/index.html) -[Thelounge](https://thelounge.github.io/) (a fork of shoutIRC) is a web IRC client that you host on your own server. +[Thelounge](https://thelounge.github.io/) \(a fork of shoutIRC\) is a web IRC client that you host on your own server. ## 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/). +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/). Simply pulling `linuxserver/thelounge` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=thelounge \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/thelounge ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,54 +60,50 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `9000` | 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. | - - ## 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 log in to the application, browse to https://:9000. -* To setup user account(s) edit `/config/config.json` -* Change the value `public: true,` to `public: false,` -* restart the container and enter the following from the command line of the host: -* `docker exec -it thelounge thelounge add ` -* Enter a password when prompted, refresh your browser. -* You should now be prompted for a password on the webinterface. - +* To log in to the application, browse to https://:9000. + * To setup user account\(s\) edit `/config/config.json` + * Change the value `public: true,` to `public: false,` + * restart the container and enter the following from the command line of the host: + * `docker exec -it thelounge thelounge add ` + * Enter a password when prompted, refresh your browser. + * You should now be prompted for a password on the webinterface. ## Support Info @@ -141,3 +129,4 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel * **14.10.16:** - Add version layer information. * **11.09.16:** - Add layer badges to README. * **31.08.16:** - Initial Release. + diff --git a/images/docker-transmission.md b/images/docker-transmission.md old mode 100755 new mode 100644 index b22db7276..55be1ff16 --- a/images/docker-transmission.md +++ b/images/docker-transmission.md @@ -1,37 +1,30 @@ -# [linuxserver/transmission](https://github.com/linuxserver/docker-transmission) +# linuxserver/transmission -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/transmission.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/transmission.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-transmission/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/transmission/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/transmission/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission) [![](https://images.microbadger.com/badges/image/linuxserver/transmission.svg)](https://microbadger.com/images/linuxserver/transmission) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/transmission.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/transmission.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-transmission/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-transmission/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/transmission/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/transmission/latest/index.html) [Transmission](https://www.transmissionbt.com/) is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more. ## 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/). +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/). Simply pulling `linuxserver/transmission` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=transmission \ -e PUID=1000 \ @@ -48,7 +41,6 @@ docker create \ linuxserver/transmission ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,45 +70,42 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `9091` | WebUI | | `51413` | Torrent Port TCP | | `51413/udp` | Torrent Port UDP | - -### 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. | | `TRANSMISSION_WEB_HOME=/combustion-release/` | Specify an alternative UI options are `/combustion-release/` and `/transmission-web-control/`. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where transmission should store config files and logs. | | `/downloads` | Local path for downloads. | | `/watch` | Watch folder for torrent 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) ``` @@ -125,7 +114,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Webui is on port 9091, the settings.json file in /config has extra settings not available in the webui. Stop the container before editing it or any changes won't be saved. -For users pulling an update and unable to access the webui setting you may need to set "rpc-host-whitelist-enabled": false, in /config/settings.json` +For users pulling an update and unable to access the webui setting you may need to set "rpc-host-whitelist-enabled": false, in /config/settings.json\` If you choose to use transmission-web-control as your default UI, just note that the origional Web UI will not be available to you despite the button being present. @@ -151,8 +140,6 @@ The automatic update is a shell script that downloads a blocklist from the url s The automatic update will run once a day at 3am local server time. - - ## Support Info * Shell access whilst the container is running: @@ -185,3 +172,4 @@ The automatic update will run once a day at 3am local server time. * **09.08.16:** - Rebase to alpine linux. * **06.12.15:** - Separate mapping for watch folder. * **16.11.15:** - Initial Release. + diff --git a/images/docker-tt-rss.md b/images/docker-tt-rss.md old mode 100755 new mode 100644 index aad5fafd4..b3d50cd3f --- a/images/docker-tt-rss.md +++ b/images/docker-tt-rss.md @@ -1,37 +1,30 @@ -# [linuxserver/tt-rss](https://github.com/linuxserver/docker-tt-rss) +# linuxserver/tt-rss -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/tt-rss.svg)](https://microbadger.com/images/linuxserver/tt-rss "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/tt-rss.svg)](https://microbadger.com/images/linuxserver/tt-rss "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tt-rss.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tt-rss.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tt-rss/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tt-rss/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tt-rss/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tt-rss/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/tt-rss.svg)](https://microbadger.com/images/linuxserver/tt-rss) [![](https://images.microbadger.com/badges/image/linuxserver/tt-rss.svg)](https://microbadger.com/images/linuxserver/tt-rss) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tt-rss.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tt-rss.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tt-rss/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tt-rss/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tt-rss/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tt-rss/latest/index.html) -[Tt-rss](https://tt-rss.org) is an open source web-based news feed (RSS/Atom) reader and aggregator, designed to allow you to read news from any location, while feeling as close to a real desktop application as possible. +[Tt-rss](https://tt-rss.org) is an open source web-based news feed \(RSS/Atom\) reader and aggregator, designed to allow you to read news from any location, while feeling as close to a real desktop application as possible. ## 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/). +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/). Simply pulling `linuxserver/tt-rss` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=tt-rss \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/tt-rss ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,63 +60,60 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where tt-rss should store it's 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 -You must create a user and database for tt-rss to use in a mysql/mariadb or postgresql server. A basic nginx configuration file can be found in /config/nginx/site-confs , edit the file to enable ssl (port 443 by default), set servername etc.. 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. +You must create a user and database for tt-rss to use in a mysql/mariadb or postgresql server. A basic nginx configuration file can be found in /config/nginx/site-confs , edit the file to enable ssl \(port 443 by default\), set servername etc.. 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. **The default username and password after initial configuration is admin/password** ## Power users + The container can configure itself using environment variables, the gaurd for this logic to run is if the variable `DB_TYPE` is set. The most common variables to set are a URL for the application and a database endpoint. IE: -* -e DB_TYPE=mysql -* -e DB_HOST=host -* -e DB_USER=user -* -e DB_NAME=name -* -e DB_PASS=password -* -e DB_PORT=3306 -* -e SELF_URL_PATH=http://localhost/ - -Please note if you use this method you need to have an already initialized database endpoint. We do our best to ensure that anything in the config.php can be set via these environment variables. +* -e DB\_TYPE=mysql +* -e DB\_HOST=host +* -e DB\_USER=user +* -e DB\_NAME=name +* -e DB\_PASS=password +* -e DB\_PORT=3306 +* -e SELF\_URL\_PATH=[http://localhost/](http://localhost/) +Please note if you use this method you need to have an already initialized database endpoint. We do our best to ensure that anything in the config.php can be set via these environment variables. ## Support Info @@ -150,3 +139,4 @@ Please note if you use this method you need to have an already initialized datab * **14.10.16:** - Add version layer information. * **10.09.16:** - Add layer badges to README. * **31.08.15:** - Initial Release. + diff --git a/images/docker-tvheadend.md b/images/docker-tvheadend.md old mode 100755 new mode 100644 index fca31a025..54d6541ae --- a/images/docker-tvheadend.md +++ b/images/docker-tvheadend.md @@ -1,28 +1,19 @@ -# [linuxserver/tvheadend](https://github.com/linuxserver/docker-tvheadend) +# linuxserver/tvheadend -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/tvheadend.svg)](https://microbadger.com/images/linuxserver/tvheadend "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/tvheadend.svg)](https://microbadger.com/images/linuxserver/tvheadend "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tvheadend.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tvheadend.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tvheadend/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tvheadend/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tvheadend/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tvheadend/latest/index.html) - -[Tvheadend](https://www.tvheadend.org/) works as a proxy server: is a TV streaming server and recorder for Linux, FreeBSD and Android supporting DVB-S, DVB-S2, DVB-C, DVB-T, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun as input sources. -Tvheadend offers the HTTP (VLC, MPlayer), HTSP (Kodi, Movian) and SAT>IP streaming. -Multiple EPG sources are supported (over-the-air DVB and ATSC including OpenTV DVB extensions, XMLTV, PyXML). +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/tvheadend.svg)](https://microbadger.com/images/linuxserver/tvheadend) [![](https://images.microbadger.com/badges/image/linuxserver/tvheadend.svg)](https://microbadger.com/images/linuxserver/tvheadend) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/tvheadend.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/tvheadend.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-tvheadend/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tvheadend/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tvheadend/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/tvheadend/latest/index.html) +[Tvheadend](https://www.tvheadend.org/) works as a proxy server: is a TV streaming server and recorder for Linux, FreeBSD and Android supporting DVB-S, DVB-S2, DVB-C, DVB-T, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun as input sources. Tvheadend offers the HTTP \(VLC, MPlayer\), HTSP \(Kodi, Movian\) and SAT>IP streaming. Multiple EPG sources are supported \(over-the-air DVB and ATSC including OpenTV DVB extensions, XMLTV, PyXML\). ## 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/). +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/). Simply pulling `linuxserver/tvheadend` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. The architectures supported by this image are: | Architecture | Tag | -| :----: | --- | +| :---: | :--- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v6-latest | @@ -32,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 | Current latest release. | | release-4.2 | Latest release from 4.2 branch. | | stable-4.2.1 | Old stable version. Will not be updated anymore! | @@ -44,7 +35,7 @@ Here are some example snippets to help you get started creating a container from ### docker -``` +```text docker create \ --name=tvheadend \ -e PUID=1000 \ @@ -63,8 +54,7 @@ docker create \ #### Host vs. Bridge -If you use IPTV, SAT>IP or HDHomeRun, you need to create the container with --net=host and remove the -p flags. This is because of a limitation in docker and multicast. - +If you use IPTV, SAT>IP or HDHomeRun, you need to create the container with --net=host and remove the -p flags. This is because of a limitation in docker and multicast. ### docker-compose @@ -96,48 +86,47 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `9981` | WebUI | | `9982` | HTSP server 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. | | `RUN_OPTS=` | Optionally specify additional arguments to be passed. See Additional runtime parameters. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Where TVHeadend show store it's config files. | | `/recordings` | Where you want the PVR to store recordings. | -#### Device Mappings (`--device`) -| Parameter | Function | -| :-----: | --- | -| `/dev/dri` | Only needed if you want to use your AMD/Intel GPU for hardware accelerated video encoding (vaapi). | -| `/dev/dvb` | Only needed if you want to pass through a DVB card to the container. If you use IPTV or HDHomeRun you can leave it out. | +#### Device Mappings \(`--device`\) +| Parameter | Function | +| :---: | :--- | +| `/dev/dri` | Only needed if you want to use your AMD/Intel GPU for hardware accelerated video encoding \(vaapi\). | +| `/dev/dvb` | Only needed if you want to pass through a DVB card to the container. If you use IPTV or HDHomeRun you can leave it out. | ## 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) ``` @@ -148,21 +137,19 @@ The setup depends if you run the one of the stable tags or use latest. Running l **Stable** -First thing to do is to go to Configuration --> DVB Inputs --> TV adapters and add your LNB/switch info. Then create a new network in the Networks tab and set the correct pre-defined muxes and orbital position. -Go back to the TV adapters tab and add the newly created network under universal LNB. Go back to the Networks tab and mark the network you created earlier and press the Force Scan button. Tvheadend will now scan the muxes for services. +First thing to do is to go to Configuration --> DVB Inputs --> TV adapters and add your LNB/switch info. Then create a new network in the Networks tab and set the correct pre-defined muxes and orbital position. Go back to the TV adapters tab and add the newly created network under universal LNB. Go back to the Networks tab and mark the network you created earlier and press the Force Scan button. Tvheadend will now scan the muxes for services. -After the scan is done, head to the Services tab and find the services you want as channels, mark them, and press map services. They should now appear under Configuration --> Channel/EPG. +After the scan is done, head to the Services tab and find the services you want as channels, mark them, and press map services. They should now appear under Configuration --> Channel/EPG. **Latest** -The first thing to do is to run the setup wizard. If it doesn't pop up at first login, you can find it in Configuration --> General --> Base and click Start Wizard. This will guide you to set up the basic parts of tvheadend. +The first thing to do is to run the setup wizard. If it doesn't pop up at first login, you can find it in Configuration --> General --> Base and click Start Wizard. This will guide you to set up the basic parts of tvheadend. **Configuring XMLTV grabber** -To configure the XMLTV grabber, first check if your grabber is listed in Configuration --> Channel/EPG --> EPG Grabber Modules. If it's listed, you will have to configure the grabber before enabling. -Find the path in the path field of your grabber. We will use the last part. It starts with tv_grab_. Add it after /usr/bin/ in the below command. There should be no space between Usr/bin/ and the part you added. +To configure the XMLTV grabber, first check if your grabber is listed in Configuration --> Channel/EPG --> EPG Grabber Modules. If it's listed, you will have to configure the grabber before enabling. Find the path in the path field of your grabber. We will use the last part. It starts with tv_grab_. Add it after /usr/bin/ in the below command. There should be no space between Usr/bin/ and the part you added. -``` +```text docker exec -it -u abc tvheadend /usr/bin/for_you_to_fill_out --configure ``` @@ -170,40 +157,32 @@ Now follow the onscreen progress. If you get asked about cache, just accept the If you allready have a configuration file, you can add it in the .xmltv folder where you mapped the /config volume. If it's not created, create it. -**Comskip** -This container comes with Comskip for commercial flagging of recordings. This you have to add in the recording config of tvheadend. -Go to Configuration --> Recording. Change the view level to advanced in the top right corner, and add the below in the Post-processor command field. +**Comskip** This container comes with Comskip for commercial flagging of recordings. This you have to add in the recording config of tvheadend. Go to Configuration --> Recording. Change the view level to advanced in the top right corner, and add the below in the Post-processor command field. -``` +```text /usr/bin/comskip --ini=/config/comskip/comskip.ini "%f" ``` Now comskip will run after each recording is finished. You will find comskip.ini in the comskip folder of your /config volume mapping. See the [Comskip](http://www.kaashoek.com/comskip/) homepage for tuning of the ini file. - **FFmpeg** FFmpeg is installed in /usr/bin/ in case you need to use it with pipe. **EPG XML file** -If you have EPG data in XML format from a supplier, you can drop it in the data folder of your /config volume mapping. If it doesn't exist, create it. Then choose the XML file grabber in Configuration --> Channel/EPG --> EPG Grabber Modules. -If you use WebGrab+Plus, choose the WebGrab+Plus XML file grabber. The XML file goes in the same path as above. -The xml file has to be named guide.xml. +If you have EPG data in XML format from a supplier, you can drop it in the data folder of your /config volume mapping. If it doesn't exist, create it. Then choose the XML file grabber in Configuration --> Channel/EPG --> EPG Grabber Modules. If you use WebGrab+Plus, choose the WebGrab+Plus XML file grabber. The XML file goes in the same path as above. The xml file has to be named guide.xml. -For advanced setup of tvheadend, go to [Tvheadend][appurl] +For advanced setup of tvheadend, go to \[Tvheadend\]\[appurl\] **Picons** -We have added all the picons from [picons.xyz](https://picons.xyz/) in the folder /picons. To enable the use of these picons, add the path to the Channel icon path in Configuration --> General --> Base. -You need to enable minimum advanced view level to see the picons options. +We have added all the picons from [picons.xyz](https://picons.xyz/) in the folder /picons. To enable the use of these picons, add the path to the Channel icon path in Configuration --> General --> Base. You need to enable minimum advanced view level to see the picons options. ## Additional runtime parameters In some cases it might be necessary to start tvheadend with additional parameters, for example to enable debugging or specify webroot for reverse proxy. Be sure to have the right parameters set, as adding the wrong once might lead to the container not starting correctly. - - ## Support Info * Shell access whilst the container is running: @@ -223,13 +202,13 @@ In some cases it might be necessary to start tvheadend with additional parameter * **14.02.19:** - Add picons path to config. * **15.01.19:** - Add pipeline logic and multi arch. * **12.09.18:** - Rebase to alpine 3.8 and use buildstage type build. -* **21.04.18:** - Add JSON::XS Perl package for grab_tv_huro. +* **21.04.18:** - Add JSON::XS Perl package for grab\_tv\_huro. * **24.03.18:** - Add dvbcsa package. * **04.03.18:** - Use sourceforge master rather than mirror for xmltv. * **22.02.18:** - Add lost libva-intel-driver. * **21.02.18:** - Fix wrong version of iconv used. * **18.02.18:** - Add vaapi support, some cleanup and dropping of deprecated options. -* **04.01.18:** - Deprecate cpu_core routine lack of scaling. +* **04.01.18:** - Deprecate cpu\_core routine lack of scaling. * **11.12.17:** - Rebase to alpine 3.7, linting fixes. * **02.09.17:** - Add codec dependencies. * **13.07.17:** - Increase uniformity across all archs. @@ -243,7 +222,8 @@ In some cases it might be necessary to start tvheadend with additional parameter * **07.02.17:** - Add variable to add additional runtime paramters. * **05.02.17:** - Update to alpine 3.5 and change dvb-apps to only compile needed libs. * **14.11.16:** - Add picons from picons.xyz to /picons folder and add info to README. -* **22.09.16:** - Fix broken tv_grab_wg, libs for xmltv and update README. +* **22.09.16:** - Fix broken tv\_grab\_wg, libs for xmltv and update README. * **18.09.16:** - Update XMLTV to 0.5.68 and update README. * **10.09.16:** - Add layer badges to README. * **05.09.16:** - Initial Release. + diff --git a/images/docker-ubooquity.md b/images/docker-ubooquity.md old mode 100755 new mode 100644 index fc522e7c3..413f17344 --- a/images/docker-ubooquity.md +++ b/images/docker-ubooquity.md @@ -1,37 +1,30 @@ -# [linuxserver/ubooquity](https://github.com/linuxserver/docker-ubooquity) +# linuxserver/ubooquity -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/ubooquity.svg)](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/ubooquity.svg)](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ubooquity.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ubooquity.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ubooquity/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ubooquity/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ubooquity/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ubooquity/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/ubooquity.svg)](https://microbadger.com/images/linuxserver/ubooquity) [![](https://images.microbadger.com/badges/image/linuxserver/ubooquity.svg)](https://microbadger.com/images/linuxserver/ubooquity) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/ubooquity.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/ubooquity.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-ubooquity/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ubooquity/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ubooquity/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ubooquity/latest/index.html) [Ubooquity](https://vaemendis.net/ubooquity/) is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer. ## 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/). +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/). Simply pulling `linuxserver/ubooquity` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=ubooquity \ -e PUID=1000 \ @@ -48,7 +41,6 @@ docker create \ linuxserver/ubooquity ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -78,53 +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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `2202` | The library port. | | `2203` | The admin 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. | | `MAXMEM=` | To set the maximum memory. | -### Volume Mappings (`-v`) +### Volume Mappings \(`-v`\) | Volume | Function | -| :----: | --- | +| :---: | :--- | | `/config` | Config files and database for ubooquity. | | `/books` | Location of books. | | `/comics` | Location of comics. | | `/files` | Location of raw 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 -**IMPORTANT** -Ubooquity has now been upgraded to [version 2](http://vaemendis.net/ubooquity/article19/ubooquity-2-1-0) and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below. +**IMPORTANT** Ubooquity has now been upgraded to [version 2](http://vaemendis.net/ubooquity/article19/ubooquity-2-1-0) and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below. Access the admin page at `http://:2203/ubooquity/admin` and set a password. @@ -136,12 +124,10 @@ This container will automatically scan your files at startup. The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get `java.lang.OutOfMemoryError:` Java heap space errors. -You can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware). +You can explicitly set the amount of memory Ubooquity is allowed to use \(be careful to set a value lower than the actual physical memory of your hardware\). If no value is set it will default to 512MB. - - ## Support Info * Shell access whilst the container is running: @@ -166,3 +152,4 @@ If no value is set it will default to 512MB. * **08.04.17:** - Switch to java from 3.5 repo, fixes login crashes. * **06.02.17:** - Rebase to alpine 3.5. * **06.12.16:** - Initial Release. + diff --git a/images/docker-znc.md b/images/docker-znc.md old mode 100755 new mode 100644 index 27921d0c0..f66cf0be6 --- a/images/docker-znc.md +++ b/images/docker-znc.md @@ -1,37 +1,30 @@ -# [linuxserver/znc](https://github.com/linuxserver/docker-znc) +# linuxserver/znc -[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) -[![](https://images.microbadger.com/badges/version/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc "Get your own version badge on microbadger.com") -[![](https://images.microbadger.com/badges/image/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc "Get your own version badge on microbadger.com") -![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/znc.svg) -![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg) -[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-znc/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-znc/job/master/) -[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/znc/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/znc/latest/index.html) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) [![](https://images.microbadger.com/badges/version/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc) [![](https://images.microbadger.com/badges/image/linuxserver/znc.svg)](https://microbadger.com/images/linuxserver/znc) ![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/znc.svg) ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/znc.svg) [![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-znc/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-znc/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/znc/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/znc/latest/index.html) [Znc](http://wiki.znc.in/ZNC) is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC. ## 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/). +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/). Simply pulling `linuxserver/znc` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 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=znc \ -e PUID=1000 \ @@ -43,7 +36,6 @@ docker create \ linuxserver/znc ``` - ### docker-compose Compatible with docker-compose v2 schemas. @@ -68,53 +60,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 `:` 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 `:` 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 | -| :----: | --- | +| :---: | :--- | | `6501` | Port ZNC listens on. | - -### 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 local ZNC data is stored. | - - ## 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 log in to the application, browse to https://:6501. +To log in to the application, browse to https://:6501. * Default User: admin * Default Password: admin -`change password ASAP.` - + `change password ASAP.` ## Support Info @@ -133,7 +121,7 @@ To log in to the application, browse to https://:6501. * **31.01.19:** - Add pipeline logic and multi arch. * **30.01.19:** - Add push and clientbuffer modules. * **17.08.18:** - Rebase to alpine 3.8, use buildstage. -* **03.01.18:** - Deprecate cpu_core routine lack of scaling. +* **03.01.18:** - Deprecate cpu\_core routine lack of scaling. * **07.12.17:** - Rebase alpine linux 3.7. * **25.10.17:** - Remove debug switch from run command. * **26.05.17:** - Rebase alpine linux 3.6. @@ -147,3 +135,4 @@ To log in to the application, browse to https://:6501. * **28.08.16:** - Add badges to README. * **20.08.16:** - Rebase to alpine linux, move to main repository. * **11.12.15:** - Initial Release. + diff --git a/images/linuxserver-sabnzb.md b/images/linuxserver-sabnzb.md new file mode 100644 index 000000000..36e2e624d --- /dev/null +++ b/images/linuxserver-sabnzb.md @@ -0,0 +1,2 @@ +# linuxserver/sabnzb +