kopia lustrzana https://github.com/linuxserver/docker-documentation
add new images, delete old ones
aptalca
rodzic
a0c7bb2d4f
commit
d4fb025249
|
|
@ -94,6 +94,7 @@
|
|||
* [linuxserver/openvpn-as](images/docker-openvpn-as.md)
|
||||
* [linuxserver/organizr](images/docker-organizr.md)
|
||||
* [linuxserver/oscam](images/docker-oscam.md)
|
||||
* [linuxserver/papermerge](images/docker-papermerge.md)
|
||||
* [linuxserver/photoshow](images/docker-photoshow.md)
|
||||
* [linuxserver/piwigo](images/docker-piwigo.md)
|
||||
* [linuxserver/pixapop](images/docker-pixapop.md)
|
||||
|
|
@ -121,6 +122,8 @@
|
|||
* [linuxserver/smokeping](images/docker-smokeping.md)
|
||||
* [linuxserver/snipe-it](images/docker-snipe-it.md)
|
||||
* [linuxserver/sonarr](images/docker-sonarr.md)
|
||||
* [linuxserver/sqlitebrowser](images/docker-sqlitebrowser.md)
|
||||
* [linuxserver/swag](images/docker-swag.md)
|
||||
* [linuxserver/synclounge](images/docker-synclounge.md)
|
||||
* [linuxserver/syncthing](images/docker-syncthing.md)
|
||||
* [linuxserver/taisun](images/docker-taisun.md)
|
||||
|
|
@ -131,6 +134,7 @@
|
|||
* [linuxserver/ubooquity](images/docker-ubooquity.md)
|
||||
* [linuxserver/unifi-controller](images/docker-unifi-controller.md)
|
||||
* [linuxserver/webgrabplus](images/docker-webgrabplus.md)
|
||||
* [linuxserver/wikijs](images/docker-wikijs.md)
|
||||
* [linuxserver/wireguard](images/docker-wireguard.md)
|
||||
* [linuxserver/wireshark](images/docker-wireshark.md)
|
||||
* [linuxserver/znc](images/docker-znc.md)
|
||||
|
|
|
|||
|
|
@ -1,100 +0,0 @@
|
|||
# linuxserver/openvpnas
|
||||
|
||||
[](https://linuxserver.io)
|
||||
|
||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring easy user mapping and community support. Find us for support at:
|
||||
|
||||
* [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://microbadger.com/images/linuxserver/openvpn-as)[](https://microbadger.com/images/linuxserver/openvpn-as)[](https://hub.docker.com/r/linuxserver/openvpn-as/)[](https://hub.docker.com/r/linuxserver/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)
|
||||
|
||||
[](https://openvpn.net/index.php/access-server/overview.html)
|
||||
|
||||
### Usage
|
||||
|
||||
```text
|
||||
docker create \
|
||||
--name=openvpn-as \
|
||||
--cap-add=NET_ADMIN \
|
||||
-v <path to data>:/config \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-p 943:943 \
|
||||
-p 9443:9443 \
|
||||
-p 1194:1194/udp \
|
||||
-e TZ=<timezone> \
|
||||
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.`
|
||||
|
||||
* `-v /config` - where openvpn-as should store configuration files
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
* `-p 943` admin gui port
|
||||
* `-p 9443` tcp port
|
||||
* `-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\).
|
||||
|
||||
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
|
||||
|
||||
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 <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
### Setting up the application
|
||||
|
||||
The admin interface is available at `https://<ip>:943/admin` with a default user/password of admin/password
|
||||
|
||||
During first login, make sure that the "Authentication" in the webui is set to "Local" instead of "PAM". Then set up the user accounts with their passwords \(user accounts created under PAM do not survive container update or recreation\).
|
||||
|
||||
The "admin" account is a system \(PAM\) account and after container update or recreation, its password reverts back to the default. It is highly recommended to block this user's access for security reasons: 1\) Create another user and set as an admin, 2\) Log in as the new user, 3\) Delete the "admin" user in the gui, 4\) Modify the `as.conf` file under config/etc and replace the line `boot_pam_users.0=admin` with `#boot_pam_users.0=admin` \(this only has to be done once and will survive container recreation\)
|
||||
|
||||
### 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`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/openvpn-as`
|
||||
|
||||
### 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.
|
||||
|
||||
|
|
@ -1,154 +0,0 @@
|
|||
# linuxserver/tt-rss
|
||||
|
||||
[](https://github.com/linuxserver/docker-tt-rss) [](https://github.com/linuxserver/docker-tt-rss/releases) [](https://github.com/linuxserver/docker-tt-rss/packages) [](https://gitlab.com/Linuxserver.io/docker-tt-rss/container_registry) [](https://quay.io/repository/linuxserver.io/tt-rss) [](https://microbadger.com/images/linuxserver/tt-rss) [](https://hub.docker.com/r/linuxserver/tt-rss) [](https://hub.docker.com/r/linuxserver/tt-rss) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-tt-rss/job/master/) [](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.
|
||||
|
||||
## 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/).
|
||||
|
||||
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 | arm32v7-latest |
|
||||
|
||||
## Version Tags
|
||||
|
||||
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 Tiny Tiny RSS releases |
|
||||
| develop | Develop Tiny Tiny RSS releases from HEAD of their master branch |
|
||||
|
||||
## 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 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Europe/London \
|
||||
-p 80:80 \
|
||||
-v <path to data>:/config \
|
||||
--restart unless-stopped \
|
||||
linuxserver/tt-rss
|
||||
```
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
tt-rss:
|
||||
image: linuxserver/tt-rss
|
||||
container_name: tt-rss
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- <path to data>:/config
|
||||
ports:
|
||||
- 80:80
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| `80` | WebUI |
|
||||
|
||||
### 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 | 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`.
|
||||
|
||||
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. PostgreSQL is recommended, as InnoDB is required if using MySQL. 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 guard 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/](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
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
* `docker exec -it tt-rss /bin/bash`
|
||||
* To monitor the logs of the container in realtime:
|
||||
* `docker logs -f tt-rss`
|
||||
* Container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' tt-rss`
|
||||
* Image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/tt-rss`
|
||||
|
||||
## Versions
|
||||
|
||||
* **06.08.19:** - Add develop branch for edge releases.
|
||||
* **28.06.19:** - Rebasing to alpine 3.10.
|
||||
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
|
||||
* **26.02.19:** - Install app in container, add php-ldap, allow env vars to generate config, thanks Neraud and Fmstrat.
|
||||
* **22.02.19:** - Rebasing to alpine 3.9.
|
||||
* **28.01.19:** - Add pipeline logic and multi arch.
|
||||
* **21.08.18:** - Rebase to alpine linux 3.8.
|
||||
* **08.01.18:** - Rebase to alpine linux 3.7.
|
||||
* **19.07.17:** - Use updated [repository](https://git.tt-rss.org/git/tt-rss) for initial install.
|
||||
* **25.05.17:** - Rebase to alpine linux 3.6.
|
||||
* **23.02.17:** - Rebase to alpine linux 3.5 and nginx.
|
||||
* **14.10.16:** - Add version layer information.
|
||||
* **10.09.16:** - Add layer badges to README.
|
||||
* **31.08.15:** - Initial Release.
|
||||
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
# linuxserver/sabnzb
|
||||
|
||||
Ładowanie…
Reference in New Issue