wbrawner/twigs
1
0
Fork 0
Code Issues Pull requests 2 Projects Releases Packages 1 Wiki Activity Actions

Update README with environment variable configuration options

Browse source 
Signed-off-by: Billy Brawner <me@wbrawner.com>
This commit is contained in:
William Brawner 2022-06-03 22:50:13 -06:00
parent 909b667c62
commit 698051fab1
2 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,6 +1,8 @@
# Twigs Server
This is the backend application that powers the [Android](../../../twigs-android), [iOS](../../../twigs-ios), and [web](../../../twigs-web) applications for Twigs, a personal finance/budgeting app. None of these apps are complete, so expect bugs, and they are all in various stages of development, so expect some feature disparity between platforms.
This is the backend application that powers the [Android](../../../twigs-android), [iOS](../../../twigs-ios),
and [web](../../../twigs-web) applications for Twigs, a personal finance/budgeting app. None of these apps are complete,
so expect bugs, and they are all in various stages of development, so expect some feature disparity between platforms.
## Prerequisites
@ -10,7 +12,10 @@ This is the backend application that powers the [Android](../../../twigs-android
## Running
Prior to running the app, make sure you have a PostgreSQL server running, with a database and user ready to go. To avoid the hassle of figuring out how to get it installed locally, using Docker is recommended, and a sample `docker-compose.yml` file is included in the root of the repository. If you already have a PostgreSQL server running, you can run the app from the command line with gradle:
Prior to running the app, make sure you have a PostgreSQL server running, with a database and user ready to go. To avoid
the hassle of figuring out how to get it installed locally, using Docker is recommended, and a
sample `docker-compose.yml` file is included in the root of the repository. If you already have a PostgreSQL server
running, you can run the app from the command line with gradle:
./gradlew run
@ -27,6 +32,11 @@ Environment Variable|Default Value|Note
`TWIGS_DB_USER`|`twigs`|PostgreSQL database user
`TWIGS_DB_PASS`|`twigs`|PostgreSQL database password
`TWIGS_PW_SALT`||Salt to use for password, generated if empty or null
`TWIGS_SMTP_FROM`||From email address for automated emails sent from Twigs
`TWIGS_SMTP_HOST`||SMTP server host for sending emails
`TWIGS_SMTP_PORT`||SMTP server port for sending emails
`TWIGS_SMTP_USER`||SMTP server username for sending emails
`TWIGS_SMTP_PASS`||SMTP server password for sending emails
## Building

2
app/src/main/resources/application.conf
View file

@ -21,8 +21,6 @@ twigs {
password = twigs
password = ${?TWIGS_DB_PASS}
}
url = localhost
url = ${?TWIGS_HOST}
password {
salt = ${?TWIGS_PW_SALT}
}