From 126aff723142391044e7fc2721da3eb497730e83 Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Tue, 24 Jan 2023 23:35:44 +0100 Subject: [PATCH 1/6] Update workflow action for publishing to new docker hub repo --- .github/workflows/hub.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/hub.yml b/.github/workflows/hub.yml index ddc1f11..709e493 100644 --- a/.github/workflows/hub.yml +++ b/.github/workflows/hub.yml @@ -38,8 +38,8 @@ jobs: uses: docker/login-action@v1 with: registry: ghcr.io - username: ${{ github.repository_owner }} - password: ${{ secrets.CR_PAT }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} - name: Build and push uses: docker/build-push-action@v2 with: @@ -52,7 +52,7 @@ jobs: # cache-from: type=local,src=/tmp/.buildx-cache # cache-to: type=local,dest=/tmp/.buildx-cache tags: | - akhilrex/hammond:latest - akhilrex/hammond:${{ steps.get_tag.outputs.TAG }} - ghcr.io/akhilrex/hammond:latest - ghcr.io/akhilrex/hammond:${{ steps.get_tag.outputs.TAG }} + alfhou/hammond:latest + alfhou/hammond:${{ steps.get_tag.outputs.TAG }} + ghcr.io/alfhou/hammond:latest + ghcr.io/alfhou/hammond:${{ steps.get_tag.outputs.TAG }} From 08f2a3547e6e2c57d273af2ed6da99dd46905e44 Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Tue, 24 Jan 2023 23:50:46 +0100 Subject: [PATCH 2/6] Rename docker secret variable --- .github/workflows/hub.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/hub.yml b/.github/workflows/hub.yml index 709e493..222efc5 100644 --- a/.github/workflows/hub.yml +++ b/.github/workflows/hub.yml @@ -33,7 +33,7 @@ jobs: uses: docker/login-action@v1 with: username: ${{ secrets.DOCKER_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} + password: ${{ secrets.DOCKER_TOKEN }} - name: Login to GitHub uses: docker/login-action@v1 with: From f96638d9132c69b27752b600307e3657803027bd Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Wed, 25 Jan 2023 00:08:32 +0100 Subject: [PATCH 3/6] Update readme with the correct url's and remove some specifics from forked repo --- README.md | 71 ++++++++++++++++++++----------------------------------- 1 file changed, 25 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 07e37d6..a646a14 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,16 @@ -[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url] - - -

- -

Hammond

Current Version - 2022.07.06

A self-hosted vehicle expense tracking system with support for multiple users.
- Explore the docs » + Explore the docs »

- - Report Bug + Report Bug · - Request Feature + Request Feature · Screenshots

@@ -44,18 +34,22 @@ ## About The Project -Hammond is a self hosted vehicle management system to track fuel and other expenses related to all of your vehicles. It supports multiple users sharing multiple vehicles. It is the logical successor to Clarkson which has not been updated for quite some time now. +Hammond is a self hosted vehicle management system to track fuel and other +expenses related to all of your vehicles. +It supports multiple users sharing multiple vehicles. +It is the logical successor to Clarkson which has not been updated for quite some time now. +This repo is again a fork of akhilrex's great [project](https://github.com/akhilrex/hammond). -_Developers Note: This project is under active development which means I release new updates very frequently. It is recommended that you use something like [watchtower](https://github.com/containrrr/watchtower) which will automatically update your containers whenever I release a new version or periodically rebuild the container with the latest image manually._ - -__Also check out my other self-hosted, open-source solution - [Podgrab](https://github.com/akhilrex/podgrab) - Podcast download and archive manager and player.__ ### Motivation and Developer Notes -I was looking for a fuel tracking system and stumbled upon Clarkson. Although it did most of what I needed it has not been updated for quite a lot of time. Since I had some bandwidth available as my previous open source project [Podgrab](http://github.com/akhilrex/podgrab) had become quite stable now, my first thought was to contribute to the Clarkson project only. I soon realized that the architecture that Clarkson had used was not really be that extensible now and would warrant a complete rewrite only. So I decided to build Hammond - The successor to Clarkson. +As mentioned, this project is a fork of +akhilrex's [project](https://github.com/akhilrex/hammond) which is no longer active. +To prevent the same from happeing to this project, we are seeking to add more +maintainers/collaborators who have access to merge PRs. -The current version of Hammond is written using GO for backend and Vuejs for the front end. Originally I had thought of using the same tech stack for both frontend and the backend so that it became easier for users and other developers to use, deploy and contribute. Which is why the first version of Hammond has a NestJS backend complete with all the bells and whistles (GraphQL, Prisma and what nots). But I eventually decided to rebuild the backend in GO just to keep the container size small. No matter how much you can optimize the sheer size of the node_modules will always add bulk to your containers. I host all my tools on my Raspberry Pi. It only makes sense to keep the container size as small as possible. +We are trying our best to update with new features and feedback is very welcome. -Also I had initially thought of a 2 container approach (1 for backend and 1 for the frontend) so that they can be independently maintained and updated. I eventually decided against this idea for the sake of simplicity. Although it is safe to assume that most self-hosters are fairly tech capable it still is much better to have a single container that you can fire and forget. +The project is written using Go for the backend and Vuejs for the front end. ![Product Name Screen Shot][product-screenshot] [More Screenshots](Screenshots.md) @@ -79,7 +73,7 @@ Also I had initially thought of a 2 container approach (1 for backend and 1 for - Save attachment against vehicles - Quick Entries (take a photo of a receipt or pump screen to make entry later) - Vehicle level and overall reporting -- Import from Fuelly (more apps coming soon) +- Import from Fuelly and Drivvo ## Installation @@ -90,24 +84,25 @@ The easiest way to run Hammond is to run it as a docker container. Simple setup without mounted volumes (for testing and evaluation) ```sh - docker run -d -p 3000:3000 --name=hammond akhilrex/hammond + docker run -d -p 3000:3000 --name=hammond alfhou/hammond ``` Binding local volumes to the container ```sh - docker run -d -p 3000:3000 --name=hammond -v "/host/path/to/assets:/assets" -v "/host/path/to/config:/config" akhilrex/hammond + docker run -d -p 3000:3000 --name=hammond -v "/host/path/to/assets:/assets" -v "/host/path/to/config:/config" alfhou/hammond ``` ### Using Docker-Compose -Modify the docker compose file provided [here](https://github.com/akhilrex/hammond/blob/master/docker-compose.yml) to update the volume and port binding and run the following command +Modify the docker compose file provided [here](https://github.com/alfhou/hammond/blob/master/docker-compose.yml) +to update the volume and port binding and run the following command ```yaml version: '2.1' services: hammond: - image: akhilrex/hammond + image: alfhou/hammond container_name: hammond volumes: - /path/to/config:/config @@ -123,7 +118,10 @@ services: ### Build from Source / Ubuntu Installation -Although personally I feel that using the docker container is the best way of using and enjoying something like hammond, a lot of people in the community are still not comfortable with using Docker and wanted to host it natively on their Linux servers. Follow the link below to get a guide on how to build hammond from source. +Although personally I feel that using the docker container is the best way of using +and enjoying something like hammond, a lot of people in the community are still not +comfortable with using Docker and wanted to host it natively on their Linux servers. +Follow the link below to get a guide on how to build hammond from source. [Build from source / Ubuntu Guide](docs/ubuntu-install.md) @@ -197,25 +195,6 @@ Distributed under the GPL-3.0 License. See `LICENSE` for more information. ## Contact -Akhil Gupta - [@akhilrex](https://twitter.com/akhilrex) +Project Link: [https://github.com/AlfHou/hammond](https://github.com/AlfHou/hammond) -Project Link: [https://github.com/akhilrex/hammond](https://github.com/akhilrex/hammond) - -Buy Me A Coffee - - - - -[contributors-shield]: https://img.shields.io/github/contributors/akhilrex/hammond.svg?style=flat-square -[contributors-url]: https://github.com/akhilrex/hammond/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/akhilrex/hammond.svg?style=flat-square -[forks-url]: https://github.com/akhilrex/hammond/network/members -[stars-shield]: https://img.shields.io/github/stars/akhilrex/hammond.svg?style=flat-square -[stars-url]: https://github.com/akhilrex/hammond/stargazers -[issues-shield]: https://img.shields.io/github/issues/akhilrex/hammond.svg?style=flat-square -[issues-url]: https://github.com/akhilrex/hammond/issues -[license-shield]: https://img.shields.io/github/license/akhilrex/hammond.svg?style=flat-square -[license-url]: https://github.com/akhilrex/hammond/blob/master/LICENSE -[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 -[linkedin-url]: https://linkedin.com/in/akhilrex [product-screenshot]: images/screenshot.jpg From a89ca5e46a106cf51c56069e30bd306a27aa0978 Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Wed, 25 Jan 2023 23:40:25 +0100 Subject: [PATCH 4/6] Update links in docker files to point to this repo --- Dockerfile | 2 +- docker-compose.yml | 2 +- server/Dockerfile | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Dockerfile b/Dockerfile index a9b7400..48682b3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -18,7 +18,7 @@ RUN npm run build FROM alpine:latest -LABEL org.opencontainers.image.source="https://github.com/akhilrex/hammond" +LABEL org.opencontainers.image.source="https://github.com/alfhou/hammond" ENV CONFIG=/config ENV DATA=/assets ENV UID=998 diff --git a/docker-compose.yml b/docker-compose.yml index 31f0ea2..fecd57d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ version: "2.1" services: hammond: - image: akhilrex/hammond + image: alfhou/hammond container_name: hammond environment: - JWT_SECRET=somethingverystrong diff --git a/server/Dockerfile b/server/Dockerfile index f2fba9c..430eb9a 100644 --- a/server/Dockerfile +++ b/server/Dockerfile @@ -16,7 +16,7 @@ RUN go build -o ./app ./main.go FROM alpine:latest -LABEL org.opencontainers.image.source="https://github.com/akhilrex/hammond" +LABEL org.opencontainers.image.source="https://github.com/alfhou/hammond" ENV CONFIG=/config ENV DATA=/assets @@ -38,4 +38,4 @@ COPY dist ./dist EXPOSE 3000 -ENTRYPOINT ["./app"] \ No newline at end of file +ENTRYPOINT ["./app"] From 9dab3d124d55545380aba3986c6e4a1437f66429 Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Wed, 25 Jan 2023 23:43:12 +0100 Subject: [PATCH 5/6] Point to this repo in ubuntu install docs --- docs/ubuntu-install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ubuntu-install.md b/docs/ubuntu-install.md index 4acb9db..df769fa 100644 --- a/docs/ubuntu-install.md +++ b/docs/ubuntu-install.md @@ -26,7 +26,7 @@ Following steps will only work if Go and Node are installed and configured prope ## Clone from Git ``` bash -git clone --depth 1 https://github.com/akhilrex/hammond +git clone --depth 1 https://github.com/alfhou/hammond ``` ## Build and Copy dependencies @@ -110,7 +110,7 @@ sudo systemctl stop hammond.service ## Clone from Git ``` bash -git clone --depth 1 https://github.com/akhilrex/hammond +git clone --depth 1 https://github.com/alfhou/hammond ``` ## Build and Copy dependencies From 4a55879ad82d5a334a661fae4cbc88b5c443ad2a Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Wed, 25 Jan 2023 23:51:33 +0100 Subject: [PATCH 6/6] Update links in more info view in settings --- ui/src/router/views/settings.vue | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/ui/src/router/views/settings.vue b/ui/src/router/views/settings.vue index f152a82..af647d6 100644 --- a/ui/src/router/views/settings.vue +++ b/ui/src/router/views/settings.vue @@ -185,7 +185,8 @@ export default {

{{ $t('passworddontmatch') }}

- + + @@ -194,12 +195,6 @@ export default {

{{ $t('moreinfo') }}

-

- This project is under active development which means I release new updates very frequently. I will eventually build the version - management/update checking mechanism. Until then it is recommended that you use something like watchtower which will automatically update - your containers whenever I release a new version or periodically rebuild the container with the latest image manually. -

-
@@ -207,15 +202,12 @@ export default { - + @@ -223,18 +215,11 @@ export default { - - - -
{{ $t('currentversion') }}
Websitehttps://github.com/akhilrex/hammondhttps://github.com/alfhou/hammond
{{ $t('foundabug') }} Report here
{{ $t('featurerequest') }} Request here
{{ $t('supportthedeveloper') }}{{ $t('buyhimabeer') }}