49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
# Hammond
|
|
|
|
Self hosted vehicle and expense management system. Like Clarkson, but better.
|
|
|
|
## Installation using Portainer
|
|
|
|
### Tested with
|
|
|
|
* Synology DS1019+ running DSM 7.1.1-42962 Update 5;
|
|
* Docker from Synology Package Center version 20.10.3-1308;
|
|
* Portainer.io Community Edition version 2.18.3;
|
|
* Hammond 1.0.0.
|
|
|
|
### Create the following folders
|
|
|
|
* docker/hammond/Hammond/config
|
|
* docker/hammond/Hammond/assets
|
|
|
|
### Installation steps
|
|
|
|
* Open Portainer with the correct environment.
|
|
* Under Stacks click the button + Add stack.
|
|
* Give your stack a name (i.e.: hammond).
|
|
* Paste the contents of compose.yml under Web editor.
|
|
* Paste the contents of .env under Environment variables.
|
|
* Click Advanced mode to be able to paste.
|
|
* Change the environment variables as you see fit.
|
|
* Click Deploy the stack and wait for Portainer to finish.
|
|
|
|
## Environment variables
|
|
|
|
The following variables could be set as an environment varaiables using the .env file.
|
|
|
|
| Value | Default | Information |
|
|
|---|---|---|
|
|
| RESTART | unless-stopped | Choose a restart policy. |
|
|
| SYNOLOGY_VOLUME | volume1 | If you have only 1 volume Docker will be installed on volume 1. |
|
|
| STACK_NAME | hammond | The name of your project/stack and also the base folder within your docker folder. |
|
|
| UID | 1024 | The user id you want to use. |
|
|
| GID | 101 | The group id you want to use. |
|
|
| HAMMOND_CONTAINER_NAME | Hammond | This is used for the name of the container and the main folder under de docker folder. |
|
|
| HAMMOND_TAG | latest | Choose a version tag. |
|
|
| HAMMOND_PORT | 3000 | Default port. |
|
|
|
|
## Links
|
|
|
|
* [Docker Hub](https://hub.docker.com/r/akhilrex/hammond)
|
|
* [GitHub](https://github.com/akhilrex/hammond)
|