Initial commit

hammond/.env.sample

@@ -0,0 +1,9 @@
+# Uncomment and change the following variables if you want to use them.
+#RESTART=unless-stopped
+#SYNOLOGY_VOLUME=volume1
+#STACK_NAME=hammond
+#UID=1024
+#GID=101
+#HAMMOND_CONTAINER_NAME=Hammond
+#HAMMOND_TAG=latest
+#HAMMOND_PORT=3000

hammond/compose.yml

@@ -0,0 +1,16 @@
+services:
+  # Hammond
+  hammond:
+    container_name: ${HAMMOND_CONTAINER_NAME:-Hammond}
+    image: akhilrex/hammond:${HAMMOND_TAG:-latest}
+    restart: ${RESTART:-unless-stopped}
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider http://localhost:3000/
+    environment:
+      UID: ${UID:-1024}
+      PID: ${GID:-101}
+    ports:
+      - ${HAMMOND_PORT:-3000}:3000
+    volumes:
+      - /${SYNOLOGY_VOLUME:-volume1}/docker/${STACK_NAME:-hammond}/${HAMMOND_CONTAINER_NAME:-Hammond}/config:/config
+      - /${SYNOLOGY_VOLUME:-volume1}/docker/${STACK_NAME:-hammond}/${HAMMOND_CONTAINER_NAME:-Hammond}/assets:/assets

hammond/readme.md

@@ -0,0 +1,46 @@
+# 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/config
+* docker/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 docker-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 an environment varaiables using the .env file.
+
+| Value | Default | Information |
+|-|-|-|
+| UID | 1024 | The user id you want to use. |
+| GID | 101 | The group id you want to use. |
+| SYNOLOGY_VOLUME | volume1 | If you have only 1 volume Docker will be installed on volume 1. |
+| RESTART | unless-stopped | Choose a restart policy. |
+| 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)