mirror of
https://github.com/linuxserver/docker-transmission.git
synced 2025-12-17 13:39:43 +01:00
Compare commits
55 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ad5f6ecfaa | ||
|
|
9f73545a49 | ||
|
|
14ced70888 | ||
|
|
4302df7270 | ||
|
|
2a202a800f | ||
|
|
227da52355 | ||
|
|
8fc46f45ec | ||
|
|
0461071b92 | ||
|
|
9fb8dcd358 | ||
|
|
328068e20d | ||
|
|
9091730d00 | ||
|
|
4246f944d6 | ||
|
|
b4e526cedf | ||
|
|
f0c27ab450 | ||
|
|
244f5c6810 | ||
|
|
d22fdb48dc | ||
|
|
97dfe76a57 | ||
|
|
76293d786a | ||
|
|
1f0f18517d | ||
|
|
f505697081 | ||
|
|
d9420323ac | ||
|
|
5138709d55 | ||
|
|
f7490f4fd7 | ||
|
|
6bad2d716e | ||
|
|
72c8df500e | ||
|
|
a1b5353ea2 | ||
|
|
96a625b9cd | ||
|
|
90510c1308 | ||
|
|
401a469bb8 | ||
|
|
8d7f56dcde | ||
|
|
c3e2acd4c9 | ||
|
|
4f5055dc4a | ||
|
|
2329699f53 | ||
|
|
8538165d17 | ||
|
|
d322a13696 | ||
|
|
33589b220f | ||
|
|
3da388bba1 | ||
|
|
fcd4c32ba5 | ||
|
|
e97bd50b83 | ||
|
|
ad91ae6396 | ||
|
|
eecebfb5c2 | ||
|
|
6c1e5e273a | ||
|
|
3420cab227 | ||
|
|
39909f7c4b | ||
|
|
9253db127d | ||
|
|
44c007bebb | ||
|
|
f310f9de7a | ||
|
|
044d7fc580 | ||
|
|
29d0edf931 | ||
|
|
4a478efa62 | ||
|
|
3142aea0d1 | ||
|
|
48b367cb91 | ||
|
|
1365022454 | ||
|
|
037c87a002 | ||
|
|
c3b8ed7c83 |
6
.dockerignore
Normal file
6
.dockerignore
Normal file
@@ -0,0 +1,6 @@
|
||||
.git
|
||||
.gitignore
|
||||
.github
|
||||
.gitattributes
|
||||
READMETEMPLATE.md
|
||||
README.md
|
||||
17
.gitattributes
vendored
Normal file
17
.gitattributes
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# Auto detect text files and perform LF normalization
|
||||
* text=auto
|
||||
|
||||
# Custom for Visual Studio
|
||||
*.cs diff=csharp
|
||||
|
||||
# Standard to msysgit
|
||||
*.doc diff=astextplain
|
||||
*.DOC diff=astextplain
|
||||
*.docx diff=astextplain
|
||||
*.DOCX diff=astextplain
|
||||
*.dot diff=astextplain
|
||||
*.DOT diff=astextplain
|
||||
*.pdf diff=astextplain
|
||||
*.PDF diff=astextplain
|
||||
*.rtf diff=astextplain
|
||||
*.RTF diff=astextplain
|
||||
21
.github/ISSUE_TEMPLATE.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
<!--- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[][linuxserverurl]
|
||||
|
||||
|
||||
<!--- If you have an issue with the project, please provide us with the following information -->
|
||||
|
||||
<!--- Host OS -->
|
||||
<!--- Command line users, your run/create command, GUI/Unraid users, a screenshot of your template settings. -->
|
||||
<!--- Docker log output, docker log <container-name> -->
|
||||
<!--- Mention if you're using symlinks on any of the volume mounts. -->
|
||||
|
||||
|
||||
<!--- If you have a suggestion or fix for the project, please provide us with the following information -->
|
||||
|
||||
<!--- What you think your suggestion brings to the project, or fixes with the project -->
|
||||
<!--- If it's a fix, would it be better suited as a Pull request to the repo ? -->
|
||||
|
||||
## Thanks, team linuxserver.io
|
||||
|
||||
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[][linuxserverurl]
|
||||
|
||||
|
||||
<!--- Before submitting a pull request please check the following -->
|
||||
|
||||
<!--- That you have made a branch in your fork, we'd rather not merge from your master -->
|
||||
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
|
||||
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
|
||||
<!--- -->
|
||||
|
||||
## Thanks, team linuxserver.io
|
||||
|
||||
43
.gitignore
vendored
Normal file
43
.gitignore
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
# Windows image file caches
|
||||
Thumbs.db
|
||||
ehthumbs.db
|
||||
|
||||
# Folder config file
|
||||
Desktop.ini
|
||||
|
||||
# Recycle Bin used on file shares
|
||||
$RECYCLE.BIN/
|
||||
|
||||
# Windows Installer files
|
||||
*.cab
|
||||
*.msi
|
||||
*.msm
|
||||
*.msp
|
||||
|
||||
# Windows shortcuts
|
||||
*.lnk
|
||||
|
||||
# =========================
|
||||
# Operating System Files
|
||||
# =========================
|
||||
|
||||
# OSX
|
||||
# =========================
|
||||
|
||||
.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# Thumbnails
|
||||
._*
|
||||
|
||||
# Files that might appear on external disk
|
||||
.Spotlight-V100
|
||||
.Trashes
|
||||
|
||||
# Directories potentially created on remote AFP share
|
||||
.AppleDB
|
||||
.AppleDesktop
|
||||
Network Trash Folder
|
||||
Temporary Items
|
||||
.apdisk
|
||||
44
Dockerfile
44
Dockerfile
@@ -1,26 +1,28 @@
|
||||
FROM linuxserver/baseimage
|
||||
FROM lsiobase/alpine:3.8
|
||||
|
||||
MAINTAINER Sparklyballs <sparklyballs@linuxserver.io>
|
||||
# set version label
|
||||
ARG BUILD_DATE
|
||||
ARG VERSION
|
||||
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
||||
LABEL maintainer="sparklyballs"
|
||||
|
||||
ENV APTLIST="transmission-daemon"
|
||||
RUN \
|
||||
echo "**** install packages ****" && \
|
||||
apk add --no-cache \
|
||||
curl \
|
||||
jq \
|
||||
openssl \
|
||||
p7zip \
|
||||
rsync \
|
||||
tar \
|
||||
transmission-cli \
|
||||
transmission-daemon \
|
||||
unrar \
|
||||
unzip
|
||||
|
||||
# add repository
|
||||
RUN add-apt-repository ppa:transmissionbt/ppa && \
|
||||
# copy local files
|
||||
COPY root/ /
|
||||
|
||||
# install packages
|
||||
apt-get update -q && \
|
||||
apt-get install $APTLIST -qy && \
|
||||
|
||||
# cleanup
|
||||
apt-get clean && rm -rf /tmp/* /var/lib/apt/lists/* /var/tmp/*
|
||||
|
||||
#Adding Custom files
|
||||
ADD init/ /etc/my_init.d/
|
||||
ADD services/ /etc/service/
|
||||
#ADD cron/ /etc/cron.d/
|
||||
ADD defaults/ /defaults/
|
||||
RUN chmod -v +x /etc/service/*/run && chmod -v +x /etc/my_init.d/*.sh
|
||||
|
||||
# Volumes and Ports
|
||||
VOLUME /config /downloads /watch
|
||||
# ports and volumes
|
||||
EXPOSE 9091 51413
|
||||
VOLUME /config /downloads /watch
|
||||
|
||||
93
README.md
93
README.md
@@ -1,56 +1,123 @@
|
||||

|
||||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://www.transmissionbt.com/
|
||||
[hub]: https://hub.docker.com/r/linuxserver/transmission/
|
||||
|
||||
The [LinuxServer.io](https://www.linuxserver.io/) team brings you another quality container release featuring auto-update on startup, easy user mapping and community support. Be sure to checkout our [forums](https://forum.linuxserver.io/index.php) or for real-time support our [IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.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/transmission
|
||||
[](https://microbadger.com/images/linuxserver/transmission "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/transmission "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-transmission/)
|
||||
|
||||
Transmission 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. [Transmission](http://www.transmissionbt.com/about/)
|
||||
|
||||
[][appurl]
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
docker create --name=transmission \
|
||||
-v /etc/localtime:/etc/localtime:ro \
|
||||
-v <path to data>:/config \
|
||||
-v <path to downloads>:/downloads \
|
||||
-v <path to watch folder>:/watch \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-p 9091:9091 -p 51413:51413 -p 51413:51413/udp \
|
||||
-e TZ=<timezone> \
|
||||
-p 9091:9091 -p 51413:51413 \
|
||||
-p 51413:51413/udp \
|
||||
linuxserver/transmission
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
## 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.`
|
||||
|
||||
|
||||
* `-p 9091`
|
||||
* `-p 51413` - the port(s)
|
||||
* `-v /etc/localtime` for timesync - *optional*
|
||||
* `-v /config` - where transmission should store config files and logs
|
||||
* `-v /downloads` - local path for downloads
|
||||
* `-v /watch` - watch folder for torrent files
|
||||
* `-e PGID` for GroupID - see below for explanation
|
||||
* `-e PUID` for UserID - see below for explanation
|
||||
* `-e TZ` for timezone information, eg Europe/London
|
||||
|
||||
It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`.
|
||||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it transmission /bin/bash`.
|
||||
|
||||
### User / Group Identifiers
|
||||
|
||||
**TL;DR** - The `PGID` and `PUID` values set the user / group you'd like your container to 'run as' to the host OS. This can be a user you've created or even root (not recommended).
|
||||
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" ™.
|
||||
|
||||
Part of what makes our containers work so well is by allowing you to specify your own `PUID` and `PGID`. This avoids nasty permissions errors with relation to data volumes (`-v` flags). When an application is installed on the host OS it is normally added to the common group called users, Docker apps due to the nature of the technology can't be added to this group. So we added this feature to let you easily choose when running your containers.
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
## Securing the webui with a username/password.
|
||||
|
||||
## Updates
|
||||
this requires 3 settings to be changed in the settings.json file.
|
||||
|
||||
`Make sure the container is stopped before editing these settings.`
|
||||
|
||||
`"rpc-authentication-required": true,` - check this, the default is false, change to true.
|
||||
|
||||
`"rpc-username": "transmission",` substitute transmission for your chosen user name, this is just an example.
|
||||
|
||||
`rpc-password` will be a hash starting with {, replace everything including the { with your chosen password, keeping the quotes.
|
||||
|
||||
Transmission will convert it to a hash when you restart the container after making the above edits.
|
||||
|
||||
## Updating Blocklists Automatically
|
||||
|
||||
This requires `"blocklist-enabled": true,` to be set. By setting this to true, it is assumed you have also populated `blocklist-url` with a valid block list.
|
||||
|
||||
The automatic update is a shell script that downloads a blocklist from the url stored in the settings.json, gunzips it, and restarts the transmission daemon.
|
||||
|
||||
The automatic update will run once a day at 3am local server time.
|
||||
|
||||
## Info
|
||||
|
||||
* Upgrade to the latest version simply `docker restart transmission`.
|
||||
* To monitor the logs of the container in realtime `docker logs -f transmission`.
|
||||
|
||||
* container version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission`
|
||||
|
||||
* image version number
|
||||
|
||||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/transmission`
|
||||
|
||||
|
||||
## Versions
|
||||
+ **06.12.2015:** Separate mapping for watch folder.
|
||||
+ **16.11.2015:** Initial Release.
|
||||
|
||||
+ **15.08.18:** Rebase to alpine linux 3.8.
|
||||
+ **12.02.18:** Pull transmission from edge repo.
|
||||
+ **10.01.18:** Rebase to alpine linux 3.7.
|
||||
+ **25.07.17:** Add rsync package.
|
||||
+ **27.05.17:** Rebase to alpine linux 3.6.
|
||||
+ **06.02.17:** Rebase to alpine linux 3.5.
|
||||
+ **15.01.17:** Add p7zip, tar , unrar and unzip packages.
|
||||
+ **16.10.16:** Blocklist autoupdate with optional authentication.
|
||||
+ **14.10.16:** Add version layer information.
|
||||
+ **23.09.16:** Add information about securing the webui to README..
|
||||
+ **21.09.16:** Add curl package.
|
||||
+ **09.09.16:** Add layer badges to README.
|
||||
+ **28.08.16:** Add badges to README.
|
||||
+ **09.08.16:** Rebase to alpine linux.
|
||||
+ **06.12.15:** Separate mapping for watch folder.
|
||||
+ **16.11.15:** Initial Release.
|
||||
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
mkdir -p /downloads/{complete,incomplete} /watch
|
||||
|
||||
[[ ! -f /config/settings.json ]] && cp /defaults/settings.json /config/settings.json
|
||||
|
||||
chown abc:abc /watch /config/settings.json /downloads /downloads/incomplete /downloads/complete
|
||||
20
root/defaults/blocklist-update.sh
Normal file
20
root/defaults/blocklist-update.sh
Normal file
@@ -0,0 +1,20 @@
|
||||
#!/usr/bin/with-contenv bash
|
||||
|
||||
BLOCKLIST_ENABLED=`jq -r '.["blocklist-enabled"]' /config/settings.json`
|
||||
BLOCKLIST_URL=`jq -r '.["blocklist-url"]' /config/settings.json | sed 's/\&/\&/g'`
|
||||
|
||||
if [ $BLOCKLIST_ENABLED == true ]; then
|
||||
mkdir -p /tmp/blocklists
|
||||
rm -rf /tmp/blocklists/*
|
||||
cd /tmp/blocklists
|
||||
wget -q -O blocklist.gz "$BLOCKLIST_URL"
|
||||
if [ $? == 0 ]; then
|
||||
gunzip *.gz
|
||||
if [ $? == 0 ]; then
|
||||
chmod go+r *
|
||||
rm -rf /config/blocklists/*
|
||||
cp /tmp/blocklists/* /config/blocklists
|
||||
s6-svc -h /var/run/s6/services/transmission
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
24
root/etc/cont-init.d/20-config
Normal file
24
root/etc/cont-init.d/20-config
Normal file
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/with-contenv bash
|
||||
|
||||
# make folders
|
||||
mkdir -p \
|
||||
/downloads/{complete,incomplete} /watch
|
||||
|
||||
# copy config
|
||||
[[ ! -f /config/settings.json ]] && cp \
|
||||
/defaults/settings.json /config/settings.json
|
||||
|
||||
# copy blocklist-update script
|
||||
[[ ! -f /config/blocklist-update.sh ]] && cp \
|
||||
/defaults/blocklist-update.sh /config/blocklist-update.sh
|
||||
|
||||
# permissions
|
||||
chown abc:abc \
|
||||
/config/settings.json \
|
||||
/config/blocklist-update.sh \
|
||||
/downloads \
|
||||
/downloads/complete \
|
||||
/downloads/incomplete \
|
||||
/watch
|
||||
|
||||
chmod 755 /config/blocklist-update.sh
|
||||
10
root/etc/crontabs/root
Normal file
10
root/etc/crontabs/root
Normal file
@@ -0,0 +1,10 @@
|
||||
# do daily/weekly/monthly maintenance
|
||||
# min hour day month weekday command
|
||||
*/15 * * * * run-parts /etc/periodic/15min
|
||||
0 * * * * run-parts /etc/periodic/hourly
|
||||
0 2 * * * run-parts /etc/periodic/daily
|
||||
0 3 * * 6 run-parts /etc/periodic/weekly
|
||||
0 5 1 * * run-parts /etc/periodic/monthly
|
||||
|
||||
# run daily blocklist update
|
||||
0 3 * * * /config/blocklist-update.sh 2>&1
|
||||
3
root/etc/services.d/cron/run
Normal file
3
root/etc/services.d/cron/run
Normal file
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/with-contenv bash
|
||||
|
||||
/usr/sbin/crond -f -S -l 0 -c /etc/crontabs
|
||||
5
root/etc/services.d/transmission/run
Normal file
5
root/etc/services.d/transmission/run
Normal file
@@ -0,0 +1,5 @@
|
||||
#!/usr/bin/with-contenv bash
|
||||
|
||||
exec \
|
||||
s6-setuidgid abc /usr/bin/transmission-daemon \
|
||||
-g /config -c /watch -f
|
||||
@@ -1,3 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
/sbin/setuser abc /usr/bin/transmission-daemon -g /config -c /watch -f
|
||||
Reference in New Issue
Block a user