Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jgeusebroek/docker-spotweb

A docker image running ubuntu/20.04 Linux and Spotweb
https://github.com/jgeusebroek/docker-spotweb

Last synced: 10 days ago
JSON representation

A docker image running ubuntu/20.04 Linux and Spotweb

Awesome Lists containing this project

README 

        
[![](https://images.microbadger.com/badges/image/jgeusebroek/spotweb.svg)](https://microbadger.com/images/jgeusebroek/spotweb "Get your own image badge on microbadger.com")

[![](https://img.shields.io/docker/pulls/jgeusebroek/spotweb.svg)](https://hub.docker.com/r/jgeusebroek/spotweb/)



# Docker Spotweb image



An image running [ubuntu/20.04](https://hub.docker.com/_/ubuntu/) Linux and [Spotweb](https://github.com/spotweb/spotweb).



## Requirements



You need a seperate MySQL / MariaDB server. This can of course be a (linked) docker container but also a dedicated database server.



If you would like to use docker-compose, a short guide can be found [below](#docker-compose). Thanks to [Daniel Jongepier](https://github.com/djongepier).



## Usage



### Initial Installation



First create a database on your database server, and make sure the container has access to the database, then run a temporary container.



	docker run -it --rm -p 80:80 \

		-e TZ='Europe/Amsterdam' \

		jgeusebroek/spotweb



Please NOTE that there is no database configuration here, this will enable the install process.



The run the Spotweb installer using the web interface: 'http://yourhost/install.php'.

This will create the necessary database tables and users. Ignore the warning when it tries to save the configuration.



When you are done, exit the container (CTRL/CMD-c) and configure the permanent running container.



### Permanent installation



	docker run --restart=always -d -p 80:80 \

		--hostname=spotweb \

		--name=spotweb \

		-v :/config \

		-e 'TZ=Europe/Amsterdam' \

		-e 'SPOTWEB_DB_TYPE=pdo_mysql' \

		-e 'SPOTWEB_DB_HOST=' \

		-e 'SPOTWEB_DB_PORT=' \

		-e 'SPOTWEB_DB_NAME=spotweb' \

		-e 'SPOTWEB_DB_USER=spotweb' \

		-e 'SPOTWEB_DB_PASS=spotweb' \

		jgeusebroek/spotweb



Please NOTE that the volume is optional. Only necessary when you have special configuration settings.

The database port is also optional. If omitted it will use the standard port for MySQL / PostgreSQL.



You should now be able to reach the spotweb interface on port 80.



### Automatic retrieval of new spots

To enable automatic retrieval, you need to setup a cronjob on either the docker host or within the container.

#### Automatic retrieval of new spots on the docker host

To enable automatic retrieval, you need to setup a cronjob on the docker host.



	*/15 * * * * docker exec spotweb su -l www-data -s /usr/bin/php /var/www/spotweb/retrieve.php >/dev/null 2>&1



This example will retrieve new spots every 15 minutes.

#### Automatic retrieval of new spots from within the container

To enable automatic retrieval from within the container, use the `SPOTWEB_CRON_RETRIEVE` variable to specify the cron timing for retrieval. For example as additional parameter to the `docker run` command:



    -e 'SPOTWEB_CRON_RETRIEVE=*/15 * * * *'



### Updates



The container will try to auto-update the database when a newer version is released.



### Docker compose



An example `docker-compose.yml` is included. Create your base directory and edit the environment variables to suit your needs. After the initial run (`docker-compose up -d`) you will need to remove the `/spotweb/dbsettings.inc.php` because otherwise the install process won't proceed. Don't worry, your settings won't be lost.



After you deleted the file, point your browser to your install (ie. [http://localhost:81/install.php](http://localhost:81/install.php)) and follow the installation procedure.



It might give you an error saying it can't write the settings to file. You can ignore this.



When this all is finished, restart spotweb using `docker-compose restart`. You should now have a working spotweb installation. (please note the `/spotweb/dbsettings.inc.php` file will be automatically recreated during the restart). 



### Environment variables

| Variable | Function |

| --- | --- |

| `TZ` | The timezone the server is running in. Defaults to `Europe/Amsterdam`. |

| `SPOTWEB_DB_TYPE` | Database type. Use `pdo_mysql` for MySQL. |

| `SPOTWEB_DB_HOST` | The database hostname / IP. |

| `SPOTWEB_DB_PORT` | The database port. Optional. |

| `SPOTWEB_DB_NAME` | The database used for spotweb. |

| `SPOTWEB_DB_USER` | The database server username. |

| `SPOTWEB_DB_PASS` | The database server password. |

| `SPOTWEB_CRON_RETRIEVE` | Cron schedule for article retrieval. E.g. `*/15 * * * *` for every fifteen minutes.|

| `SPOTWEB_CRON_CACHE_CHECK` | Cron schedule for article cache sanity check. E.g. `10 */1 * * *` for 10 minutes after every hour. |

| `WEBSERVER_PORT` | Change the webserver port (for when you can't use port mapping with host network for example)|



## License



MIT / BSD



## Author Information



[Jeroen Geusebroek](https://jeroengeusebroek.nl/)