https://github.com/yukiisbored/planet-venus-docker
Docker Image and Compose setup for planet-venus
https://github.com/yukiisbored/planet-venus-docker
docker-image planet-venus rss-aggregator
Last synced: 10 months ago
JSON representation
Docker Image and Compose setup for planet-venus
- Host: GitHub
- URL: https://github.com/yukiisbored/planet-venus-docker
- Owner: yukiisbored
- Created: 2017-02-17T11:16:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-26T13:08:20.000Z (almost 9 years ago)
- Last Synced: 2025-03-27T01:51:34.458Z (over 1 year ago)
- Topics: docker-image, planet-venus, rss-aggregator
- Language: Shell
- Size: 15.6 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# planet-venus Docker Image
This is a docker image for planet-venus. This image is created to make deployment
of planet-venus easier. This image also contains `lighttpd` as the web server,
because planet-venus it self is a static page generator.
A cron daemon with a crontab has been setup to update the pages every 30 mins
## Environment variables reference
| Variable | Description | Default |
|----------------------|--------------------------------------------|---------------------|
| `PLANET_DIRECTORY` | The directory for the planet configuration | `/planet` |
| `PLANET_CONFIG_FILE` | The configuration file for the planet | `/planet/planet.ini |
| `PLANET_OUTPUT` | The HTML output for the planet | `/planet/output` |
## How to use?
### With vendored configuration images
Currently, the image comes with the default planet configuration, we recommend
adding your planet by creating a `Dockerfile` and using this image as the base,
like this:
```Dockerfile
FROM yukiisbored/planet-venus
COPY crontab /etc/crontab
COPY my-awesome-planet /planet
```
The reason why this is a preferable way is because it'll easy to transfer than
having externally defined volumes. With this, you can just start the image
without a lot of configuration.
### With defined external volumes
If you prefer using external volumes, you can defined volumes for your planet
configuration with Compose or the docker command directly:
**docker-compose.yml**
```yaml
version: '2'
services:
planet:
image: yukiisbored/planet-venus
volume:
- ./my-awesome-planet:/planet
```
**`docker` command**
`docker run -v ./my-awesome-planet:/planet yukiisbored/planet-venus`
If you're using another directory, You can use the `PLANET_DIRECTORY`,
`PLANET_CONFIG_FILE`, and `PLANET_OUTPUT` environment variables:
**docker-compose.yml**
```yaml
version: '2'
services:
planet:
image: yukiisbored/planet-venus
volume:
- ./my-awesome-planet:/my-awesome-planet
environment:
- PLANET_DIRECTORY=/my-awesome-planet
- PLANET_CONFIG_FILE=/my-awesome-planet/config.ini
- PLANET_OUTPUT=/my-awesome-planet/output
```
**`docker` command**
```
docker run -v ./my-awesome-planet:/my-awesome-planet \
-e PLANET_DIRECTORY=/my-awesome-planet \
-e PLANET_CONFIG_FILE=/my-awesome-planet/config.ini \
-e PLANET_OUTPUT=/my-awesome-planet/output \
yukiisbored/planet-venus
```