From cc3ffdd75d48678f9bde6191f1ef6dfc94c31993 Mon Sep 17 00:00:00 2001 From: Gabriel Arakaki Giovanini Date: Sun, 16 Oct 2022 19:04:17 +0200 Subject: ref: update readme to update docker info --- README.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 296e210..2574d49 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ - [![pipeline - status](https://gitlab.com/gabrielgio/reddit-nextcloud-importer/badges/main/pipeline.svg)](https://gitlab.com/gabrielgio/reddit-nextcloud-importer/-/commits/main) - [![coverage - report](https://gitlab.com/gabrielgio/reddit-nextcloud-importer/badges/main/coverage.svg)](https://gitlab.com/gabrielgio/reddit-nextcloud-importer/-/commits/main) - # Reddit Nextcloud importer A process to import images and videos from saved post on reddit to a instance of Nextcloud. +## apk + +This project is available as an apk at [apkbuilds](https://git.sr.ht/~gabrielgio/apkbuilds). # Environment variables @@ -19,7 +17,7 @@ Nextcloud. * You can use `http://localhost:8080` on `redirect uri` field as you won't need it. -* `REDDIT_USERNAME` and `REDDIT_PASSWORD`: user credenctial to access Reddit's +* `REDDIT_USERNAME` and `REDDIT_PASSWORD`: user credential to access Reddit's API. Because you chose `script` that user need to be listed as a developer in the application page. To add a new user as a developer go to [authorized application page](https://www.reddit.com/prefs/apps) and click on the `edit` @@ -33,7 +31,7 @@ Nextcloud. * `NEXTCLOUD_PATH`: root folder for where all the images will be saved. -* `FROM_BEGINNING`: it will download all the files since the first availabile +* `FROM_BEGINNING`: it will download all the files since the first available saved post. * `LOG_LEVEL`: it will set the log level: @@ -42,6 +40,30 @@ Nextcloud. # Running as docker container +Since I'm not distributing this project as docker anymore feel free to build it +yourself. I have it packed for alpine already, you can start with the following +dockerfile + +```dockerfile +FROM alpine:3.16 + +RUN apk add curl + +RUN echo "https://artifacts.gabrielgio.me/repo/v3.16/" >> /etc/apk/repositories +RUN curl https://artifacts.gabrielgio.me/repo/mail%40gabrielgio.me-62ddc4dc.rsa.pub \ + -o /etc/apk/keys/mail@gabrielgio.me-62ddc4dc.rsa.pub + +RUN apk add reddit-nextcloud-importer + +ENTRYPOINT reddit-nextcloud-importer +``` + +then run: + +```shell +docker build -t reddit-nextcloud-importer . +``` + To run as docker you need to pass all the environment variables listed above: ```BASH @@ -54,5 +76,5 @@ docker run -d --rm \ -e NEXTCLOUD_USERNAME=$NEXTCLOUD_USERNAME \ -e NEXTCLOUD_PASSWORD=$NEXTCLOUD_PASSWORD \ -e NEXTCLOUD_PATH=$NEXTCLOUD_PATH \ - registry.gitlab.com/gabrielgio/reddit-nextcloud-importer:latest + reddit-nextcloud-importer:latest ``` -- cgit v1.2.3