first inklings

This commit is contained in:
sparklyballs
2015-11-13 08:06:39 +00:00
commit a8c08a7273
3 changed files with 80 additions and 0 deletions

26
Dockerfile Normal file
View File

@@ -0,0 +1,26 @@
FROM linuxserver/baseimage
MAINTAINER Sparklyballs <sparklyballs@linuxserver.io>
ENV APTLIST="transmission-daemon"
# add repository
RUN add-apt-repository ppa:transmissionbt/ppa && \
# 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
EXPOSE 9091 51413

8
README.md Normal file
View File

@@ -0,0 +1,8 @@
![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
## This is a Container in active development, and should not be used by the general public.
If you are curious about the current progress or want to comment\contribute to this work, feel free to join us at out irc channel:
[IRC](https://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`.
or visit our website at [https://linuxserver.io](https://www.linuxserver.io/)

46
READMETEMPLATE.md Normal file
View File

@@ -0,0 +1,46 @@
![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
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`.
# linuxserver/<container-name>
<Provide a short, concise description of the application. No more than two SHORT paragraphs. Link to sources where possible and include an image illustrating your point if necessary. Point users to the original applications website, as that's the best place to get support - not here.>
## Usage
```
docker create --name=<container-name> -v /etc/localtime:/etc/localtime:ro -v <path to data>:/config -e PGID=<gid> -e PUID=<uid> -p 1234:1234 linuxserver/<container-name>
```
**Parameters**
* `-p 4242` - the port(s)
* `-v /etc/localtime` for timesync - *optional*
* `-v /config` -
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it <container-name> /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).
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.
## Setting up the application
<Insert a basic user guide here to get a n00b up and running with the software inside the container.> DELETE ME
## Updates
* Upgrade to the latest version simply `docker restart <container-name>`.
* To monitor the logs of the container in realtime `docker logs -f <container-name>`.
## Versions
+ **dd.MM.yyyy:** This is the standard Version type now.