mirror of
https://github.com/linuxserver/docker-sickgear.git
synced 2026-02-20 01:02:35 +08:00
Convert to the newer readme template style
This commit is contained in:
anoma
GitHub
parent
9a68c226fa
commit
f5b16ec58c
96
README.md
96
README.md
@ -4,21 +4,38 @@
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://sickgear.github.io/
|
||||
[hub]: https://hub.docker.com/r/linuxserver/sickgear/
|
||||
[localesurl]: https://sickgear.github.io/
|
||||
|
||||
|
||||
[][linuxserverurl]
|
||||
|
||||
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!
|
||||
|
||||
# linuxserver/sickgear
|
||||
## Contact information:-
|
||||
|
||||
| Type | Address/Details |
|
||||
| :---: | --- |
|
||||
| Discord | [Discord](https://discord.gg/YWrKVTn) |
|
||||
| Forum | [Linuserver.io forum][forumurl] |
|
||||
| IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl]
|
||||
| Podcast | Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! [Linuxserver.io Podcast][podcasturl] |
|
||||
|
||||
|
||||
The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :-
|
||||
|
||||
+ regular and timely application updates
|
||||
+ easy user mappings
|
||||
+ custom base image with s6 overlay
|
||||
+ security updates
|
||||
|
||||
# linuxserver/sickgear(huburl)
|
||||
[](https://microbadger.com/images/linuxserver/sickgear "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/sickgear "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-sickgear/)
|
||||
|
||||
SickGear provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. [sickgear](https://github.com/SickGear/SickGear/)
|
||||
|
||||
[][appurl]
|
||||
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
@ -33,13 +50,14 @@ docker create --name=sickgear \
|
||||
linuxserver/sickgear
|
||||
```
|
||||
|
||||
## 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.
|
||||
## Required 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.`
|
||||
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
|
||||
|
||||
* `-p 8081` - the port(s)
|
||||
* `-v /config` - where sickgear should store config files.
|
||||
@ -49,22 +67,49 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
* `-e TZ` for timezone information, eg Europe/London
|
||||
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it sickgear /bin/bash`.
|
||||
|
||||
### User / Group Identifiers
|
||||
| Parameter | Function |
|
||||
| :---: | --- |
|
||||
| `-p 8081` | the port(s) |
|
||||
| `-v /config` | Contains your config files and data storage for sickgear|
|
||||
| `-v /downloads` | Your downloads folder for post processing(must not be donwload in progress)|
|
||||
| `-v /tv` | Your tv-shows folder|
|
||||
| `-v /config` | Contains your config files and data storage for sickgear|
|
||||
| `-e PGID` | for GroupID, see below for explanation |
|
||||
| `-e PUID` | for UserID, see below for explanation |
|
||||
|
||||
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:
|
||||
## Optional Parameters
|
||||
|
||||
The application accepts extra environment variables to further customize itself on boot:
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | --- |
|
||||
| `-e TZ=` | The timezone the application will use IE US/Pacific|
|
||||
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
Sometimes when using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
|
||||
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
## Setting up the application
|
||||
|
||||
|
||||
Web interface is at `<your ip>:8081` , set paths for downloads, tv-shows to match docker mappings via the webui.
|
||||
## Setting up the application
|
||||
|
||||
Access the webui at `<your-ip>:8081`, for more information check out [sickgear][appurl].
|
||||
|
||||
|
||||
|
||||
## Migration
|
||||
|
||||
@ -88,19 +133,22 @@ Its is recommened that a clean install be completed rather than a migration howe
|
||||
|
||||
* start the new container and test
|
||||
|
||||
## Info
|
||||
|
||||
|
||||
* To monitor the logs of the container in realtime `docker logs -f sickgear`.
|
||||
|
||||
* container version number
|
||||
## Container access and information.
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' sickgear`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickgear`
|
||||
| Function | Command |
|
||||
| :--- | :--- |
|
||||
| Shell access (live container) | `docker exec -it sickgear /bin/bash` |
|
||||
| Realtime container logs | `docker logs -f sickgear` |
|
||||
| Container version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' sickgear` |
|
||||
| Image version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickgear` |
|
||||
|
||||
|
||||
|
||||
## Versions
|
||||
|
||||
+ **07.07.18:** Initial draft creation
|
||||
| Date | Changes |
|
||||
| :---: | --- |
|
||||
| 07.07.18 | Initial Draft Release. |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user