Add usage docs (#7)
This commit is contained in:
14
README.md
Normal file
14
README.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
# hesk-docker
|
||||||
|
HESK help desk, but in a Docker container.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- You will need a MySQL/MariaDB database. This image does not include a database server so please deploy one before installing.
|
||||||
|
|
||||||
|
## How to use
|
||||||
|
*An example Docker Compose file is included in this repository.*
|
||||||
|
|
||||||
|
1. See [this page](https://github.com/luketainton/hesk-docker/pkgs/container/hesk) for the latest version.
|
||||||
|
2. Pull the version of the image that you want (e.g. latest): `docker pull ghcr.io/luketainton/hesk:latest`.
|
||||||
|
3. Run the container: `docker run -p 127.0.0.1:80:80 ghcr.io/luketainton/hesk:latest`.
|
||||||
|
4. Open your web browser to http://127.0.0.1/install (change IP/hostname for what you used in the last step).
|
||||||
|
5. Follow the instructions to install your HESK instance.
|
||||||
25
docker-compose.example.yml
Normal file
25
docker-compose.example.yml
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
version: "3"
|
||||||
|
services:
|
||||||
|
db:
|
||||||
|
image: mariadb:10.7
|
||||||
|
volumes:
|
||||||
|
- db_data:/var/lib/mysql
|
||||||
|
restart: always
|
||||||
|
environment:
|
||||||
|
MARIADB_RANDOM_ROOT_PASSWORD: yes
|
||||||
|
MARIADB_DATABASE: hesk
|
||||||
|
MARIADB_USER: hesk
|
||||||
|
# Please change the password before deploying.
|
||||||
|
MARIADB_PASSWORD: hesk
|
||||||
|
|
||||||
|
wordpress:
|
||||||
|
depends_on:
|
||||||
|
- db
|
||||||
|
image: ghcr.io/luketainton/hesk:latest
|
||||||
|
ports:
|
||||||
|
- "80:80"
|
||||||
|
restart: always
|
||||||
|
volumes:
|
||||||
|
db_data: {}
|
||||||
|
...
|
||||||
Reference in New Issue
Block a user