rlkollman/actual-helpers
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Woodson Gates
2024-08-11 21:51:50 -04:00
committed by GitHub
parent 8cc9e45669
commit 883d3302c6
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -1
View File
@@ -228,21 +228,29 @@ It is recommended to run this script once per month.
# Setup with Docker: # Setup with Docker:
This guide assumes you already have a working version of docker installed and have cloned the repo to a location of your choice. This guide assumes you already have a working version of docker installed and have cloned the repo to a location of your choice.
Build the container image_ Build the container image
`docker build -t actual-helper ./` `docker build -t actual-helper ./`
Test if the docker container works correctly. Test if the docker container works correctly.
`docker run -itd actual-helper --name actual-helper` `docker run -itd actual-helper --name actual-helper`
`docker exec actual-helper node sync-banks.js` `docker exec actual-helper node sync-banks.js`
If it is working correctly the bank sync should execute and run. Now lets automate this to run on a schedule. To do this we will be using systemd timers and a shell script to create a new container and execute the update scripts we want to use. If it is working correctly the bank sync should execute and run. Now lets automate this to run on a schedule. To do this we will be using systemd timers and a shell script to create a new container and execute the update scripts we want to use.
Allow the script to be executed. Update the script where it does `docker exec` to include any of the scripts you wish to run. Allow the script to be executed. Update the script where it does `docker exec` to include any of the scripts you wish to run.
`chmod +x ./update.sh` `chmod +x ./update.sh`
Update the actual-helper.service file to point to the correct location of the update.sh file. Change the user and group info if needed. Also add a healthchecks.io ID to the **.env** if you want to automate alerting as well. Update the actual-helper.service file to point to the correct location of the update.sh file. Change the user and group info if needed. Also add a healthchecks.io ID to the **.env** if you want to automate alerting as well.
`mv ./actual-helper.timer /etc/systemd/system` `mv ./actual-helper.timer /etc/systemd/system`
`mv ./actual-helper.service /etc/systemd/system` `mv ./actual-helper.service /etc/systemd/system`
`systemctl enable actual-helper.timer` `systemctl enable actual-helper.timer`
`systemctl enable actual-helper.service` `systemctl enable actual-helper.service`
Note: The timer is configured to run at midnight daily by default. Note: The timer is configured to run at midnight daily by default.