56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# Auto_news
|
|
|
|
A utility to fetch article requests from slack and generate pdfs for them, fully automatically.
|
|
|
|
|
|
## Running
|
|
### How to run - auto archiving mode
|
|
In this mode the program is launched as a docker container, in a headless mode. For persistence purposes a local storage volume is required, but that's it!
|
|
|
|
`docker run -it -v <your storage>:/app/file_storage/ auto_news`
|
|
|
|
You can specify additional parameters:
|
|
|
|
`docker run -it -v <your storage>:/app/file_storage/ auto_news debug` runs with debug values (does not write to prod db, does not send mails)
|
|
|
|
`docker run -it -v <your storage>:/app/file_storage/ auto_news upload` catches up on incomplete uploads to archive.
|
|
|
|
`docker run -it -v <your storage>:/app/file_storage/ -e DISPLAY=":0" --network host -v \$XAUTHORITY:/root/.Xauthority auto_news check` lets you visually verify the downloaded files. The additional parameters are required in order to open guis on the host.
|
|
|
|
|
|
### How to run - development mode
|
|
In this mode, a docker container is launched with an additional volume, the local code. You can test your code without the need to rebuild the image.
|
|
|
|
`docker run -it -v <your storage>:/app/file_storage/ -v <your code>:/code/ --entry-point /bin/bash auto_news`
|
|
You are droppped into a bash shell, in which you can navigate to the `/code` directory and then test live.
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
### Things to keep in mind
|
|
The software (firefox, selenium, python) changes frequently. For non-breaking changes it is useful to regularly clean build the docker image! This is also crucial to update the code itself.
|
|
|
|
|
|
`docker build -t auto_news --no-cache .`
|
|
where the `Dockerfile` has to be in the working directory
|
|
|
|
|
|
|
|
## Cheat-sheet Remy:
|
|
|
|
`docker run -it -v /mnt/Data/COSS/DOWNLOADS/auto_news/container_data/:/app/file_storage/ auto_news`
|
|
|
|
`docker run -it -v /mnt/Data/COSS/DOWNLOADS/auto_news/container_data/:/app/file_storage/ -v /mnt/Data/COSS/auto_news/app:/code --entrypoint /bin/bash auto_news`
|
|
|
|
|
|
`docker run -it -v /mnt/Data/COSS/DOWNLOADS/auto_news/container_data/:/app/file_storage/ -e DISPLAY=":0" --network host -v \$XAUTHORITY:/root/.Xauthority auto_news check`
|
|
|
|
|
|
|
|
## Roadmap:
|
|
|
|
[] automatically upload files to NAS
|
|
[] handle paywalled sites like faz, spiegel, .. through their dedicated edu-sites
|
|
... |