Skip to content

Commit

Permalink
Added Docker files, extended README (Waterboy1602#3)
Browse files Browse the repository at this point in the history
* Added Dockerfile and docker-compose.yml

* Added section about Docker

* Update README.md

* Update README.md
  • Loading branch information
tedvdb authored and Waterboy1602 committed Dec 29, 2019
1 parent b8ed63b commit 97d32b6
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 7 deletions.
14 changes: 14 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
FROM python:3.6-alpine

WORKDIR /usr/src
# Install requirements
RUN apk add --no-cache gcc musl-dev libffi-dev openssl-dev
# Copy files to container
COPY . /usr/src/addarr
# Install ans build Addarr requirements, make symlink to redirect logs to stdout
RUN cd addarr && \
pip install --no-cache-dir -r requirements.txt --upgrade && \
ln -s /dev/stdout /usr/src/telegramBot.log

ENTRYPOINT ["python"]
CMD ["/usr/src/addarr/addarr.py"]
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# ADDARR

This is a TelegramBot made to add series to [Sonarr](https://github.com/Sonarr/Sonarr) or movies to [Radarr](https://github.com/Radarr/Radarr with a couple of commands.
This is a TelegramBot made to add series to [Sonarr](https://github.com/Sonarr/Sonarr) or movies to [Radarr](https://github.com/Radarr/Radarr) with a couple of commands.

### HOW IT WORKS
You can start the bot with sending a message or command 'start'
## HOW IT WORKS
You can start the bot with sending a message or command `/start`.
The rest will be made clear by the bot.

The rest will be made clear by the bot

### SCREENSHOTS
## SCREENSHOTS
<div style="float: left">
<img src="https://i.imgur.com/gO4UGG6.png" height="350" style="padding-right: 50px">
<img src="https://i.imgur.com/6UAmcAk.png" height="350" style="padding-right: 50px">
<img src="https://i.imgur.com/1X3xUNA.png" height="350" style="padding-right: 50px">
</div>

### INSTALLATION
## INSTALLATION
### FreeBSD
For the moment I only made a wikipage for [installation on FreeBSD](https://github.com/Waterboy1602/Addarr/wiki/Installation-on-FreeBSD). If there is interest for other wikipages, just tell me and I will look for it.
### Docker
* To build a docker image use the command `docker-compose build`.
* After that copy the provided `config_example.yaml` to `config.yaml` and set the values to your configuration.
* Then you can use the provided docker-compose file to run the bot using the command `docker-compose up -d`.
9 changes: 9 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: '3'
services:
addarr:
container_name: addarr_bot
build: .
restart: unless-stopped
network_mode: host
volumes:
- ./config.yaml:/usr/src/addarr/config.yaml:ro

0 comments on commit 97d32b6

Please sign in to comment.