mirror of
https://github.com/jgeusebroek/docker-spotweb.git
synced 2025-08-09 22:57:45 +02:00
Several changes for public release.
This commit is contained in:
45
README.md
45
README.md
@@ -1,11 +1,48 @@
|
||||
# Docker spotweb
|
||||
[](https://imagelayers.io/?images=jgeusebroek/spotweb:latest 'Get your own badge on imagelayers.io')
|
||||
|
||||
# Docker Spotweb image
|
||||
|
||||
An image running [ubuntu/15.10](https://github.com/gliderlabs/docker-alpine) Linux and [Spotweb](https://github.com/spotweb/spotweb) (media branch).
|
||||
|
||||
This image was mainly for own use, but it seems to be populair so I decided to provide some documentation.
|
||||
|
||||
## MySQL
|
||||
|
||||
You need a seperate MySQL / MariaDB server. This can be a ofcourse be a (linked) docker container but also a dedicated database server.
|
||||
|
||||
## Updates
|
||||
|
||||
The container will try to auto-update the database when a newer version image is released.
|
||||
|
||||
## Usage
|
||||
|
||||
docker run --restart=always -d -p 80:80 \
|
||||
--hostname=spotweb \
|
||||
--name=spotweb \
|
||||
-v /config:/config \
|
||||
-v <hostdir_where_config_will_persistently_be_stored>:/config \
|
||||
-e TZ='Europe/Amsterdam'
|
||||
-e SPOTWEB_DB_TYPE=pdo_mysql \
|
||||
-e SPOTWEB_DB_HOST=<hostname> \
|
||||
-e SPOTWEB_DB_HOST=<database_server_hostname> \
|
||||
-e SPOTWEB_DB_NAME=spotweb \
|
||||
-e SPOTWEB_DB_USER=spotweb \
|
||||
-e SPOTWEB_DB_PASS=spotweb \
|
||||
jgeusebroek/spotweb
|
||||
jgeusebroek/spotweb
|
||||
|
||||
You should now be able to reach the spotweb interface on port 80, and you can configure Spotweb.
|
||||
|
||||
## Environment variables
|
||||
|
||||
* `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 hostname / IP of the database server.
|
||||
* `SPOTWEB_DB_NAME` The database used for spotweb.
|
||||
* `SPOTWEB_DB_USER` The database server username.
|
||||
* `SPOTWEB_DB_PASS` The database server password.
|
||||
|
||||
## License
|
||||
|
||||
MIT / BSD
|
||||
|
||||
## Author Information
|
||||
|
||||
[Jeroen Geusebroek](https://jeroengeusebroek.nl/)
|
Reference in New Issue
Block a user