From 0bdd1fe2436e56ac8cc8843b6da4c1f1b516fa01 Mon Sep 17 00:00:00 2001 From: "Beniamin S. @ TSA" Date: Fri, 19 Sep 2025 14:39:27 +0300 Subject: [PATCH 1/3] updated readme --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8d08e29d7..c6f1d6634 100644 --- a/README.md +++ b/README.md @@ -34,14 +34,9 @@

- - fasten_view - -
- See more Fasten screenshots + Fasten Local Import

- # Introduction Like many of you, I've worked for many companies over my career. In that time, I've had multiple health, vision and dental @@ -208,6 +203,20 @@ This allows for a more complex example: - both parents need to be able to access both children's records, and maybe each-others - the caregiver should have view-only access to 1 or both children, but not the parents. +# Mobile application + +In partnership with [LifeValue](https://lifevalue.com), we develop a mobile application: **[HealthWallet.me](https://github.com/TechStackApps/HealthWallet.me)**, that syncs with your **self-hosted Fasten instance**, giving you access to your health records on the mobile. + + + Download on the App Store + + + Get it on Google Play + + +![HealthWallet.me Mobile App](https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/cb77164776cacddc621750394cbd091e90cb14ea/assets/readme/app.gif) + + # FAQ's @@ -250,6 +259,8 @@ We use SemVer for versioning. For the versions available, see the tags on this r We'd like to thank the following Corporate Sponsors: + +LifeValue From 12939136c63f1b24448f1d4e575605f95f554639 Mon Sep 17 00:00:00 2001 From: "Beniamin S. @ TSA" Date: Mon, 22 Sep 2025 14:17:08 +0300 Subject: [PATCH 2/3] update --- README.md | 139 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 79 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index c6f1d6634..1b401a42d 100644 --- a/README.md +++ b/README.md @@ -87,58 +87,26 @@ First, if you don't have Docker installed on your computer, get Docker by follow Next, run the following commands from the Windows command line or Mac/Linux terminal in order to download and start the Fasten docker container. +## 🚀 Launch -### 🚀 Launch +### Start Fasten -Launch the application. Please choose a location where `docker-compose.yml` and `set_env.sh` will be downloaded. - -To make your Fasten instance discoverable by companion mobile apps and other devices on your local network, you need to run the `set_env.sh` script before starting Docker Compose. This script sets the necessary `HOSTNAME` and `IP` values in a `.env` file, which is required for syncing. - -Here are the step-by-step instructions: - -1. **Download necessary files:** +1. **Download necessary file:** ```bash curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/docker-compose-prod.yml -o docker-compose.yml - curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/set_env.sh -o set_env.sh - ``` - -2. **Prepare and run the environment setup script:** - Make the script executable and run it to generate your `.env` file. This will configure network variables required for Docker Compose. - ```bash - chmod +x ./set_env.sh - ./set_env.sh ``` -3. **Start the application:** +2. **Start the application:** ```bash docker compose up -d ``` -**Manual Configuration (Optional)** - -If you prefer not to run the `set_env.sh` script, you can configure the `.env` file manually. You will need to create a `.env` file and add the following variables: - -1. **Find your hostname:** - ```bash - hostname - ``` -2. **Find your local IP address:** - * **macOS:** `ifconfig | grep "inet " | grep -v 127.0.0.1 | cut -d' ' -f2` - * **Linux:** `hostname -I | awk '{print $1}'` - * **Windows (Command Prompt):** `ipconfig | findstr /i "ipv4"` - -3. **Create and edit the `.env` file:** - Create a file named `.env` in the same directory as your `docker-compose.yml` and add the following lines, replacing `` and `` with the values you found: - ``` - HOSTNAME= - IP= - PORT=9090 - ``` - ### đŸ§Ē Develop Use local development settings for testing and iteration. +> â„šī¸ **Observation:** Requires a local clone of the repository. + ```bash docker compose up -d ``` @@ -149,11 +117,11 @@ docker compose up -d make serve-docker ``` -â„šī¸ Requires a local clone of the repository. - > âš ī¸ **Warning:** Do not run both `docker compose up -d` / `(make serve-docker)` simultaneously. Choose one based on your deployment scenario. -### Optional +Next, open a browser to `http://localhost:9090` + +### (Optional) Direct start Fasten using docker run ``` docker pull ghcr.io/fastenhealth/fasten-onprem:main @@ -165,9 +133,75 @@ docker run --rm \ ghcr.io/fastenhealth/fasten-onprem:main ``` -Next, open a browser to `http://localhost:9090` -At this point you'll be redirected to the login page. +### Companion Mobile App + +In partnership with [LifeValue](https://lifevalue.com), we develop an **open-source** mobile application: **[HealthWallet.me](https://healthwallet.me/)** / **[Github repository](https://github.com/TechStackApps/HealthWallet.me)** , that syncs with your **self-hosted Fasten instance**, giving you access to your health records on the mobile. + + + + Download on the App Store + + + Get it on Google Play + + +![HealthWallet.me Mobile App](https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/cb77164776cacddc621750394cbd091e90cb14ea/assets/readme/app.gif) + + + +### Start Fasten (discovarable on your local network) + +For your **Fasten** instance to work together with **HealthWallet.me** (the companion mobile app), you need to run the `set_env.sh` script before starting Docker Compose. + +This script configures the necessary `HOSTNAME` and `IP` values in a `.env` file, which allows Fasten to generate a QR code that HealthWallet can scan to establish the initial connection and begin syncing your health data. + +Launch the application. Please choose a location where `docker-compose.yml` and `set_env.sh` will be downloaded. + + +#### **Quick Setup:** + +1. **Download necessary files** + ```bash + curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/docker-compose-prod.yml -o docker-compose.yml && \ + curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/set_env.sh -o set_env.sh && \ + chmod +x ./set_env.sh && \ + ./set_env.sh + ``` +2. **Start the application:** + ```bash + docker compose up -d + ``` + +- **Commands Breakdown** + - Downloads necessary files (**docker-compose.yml** and **set_env.sh**) + - The environment script automatically assigns your local IP so **Fasten** can be available on **your local network** + - Starts the Fasten application (**docker-compose up -d**) + + +
+ Manual Configuration (Optional) + +If you prefer not to run the `set_env.sh` script, you can configure the `.env` file manually. You will need to create a `.env` file and add the following variables: + +1. **Find your hostname:** + ```bash + hostname + ``` +2. **Find your local IP address:** + * **macOS:** `ifconfig | grep "inet " | grep -v 127.0.0.1 | cut -d' ' -f2` + * **Linux:** `hostname -I | awk '{print $1}'` + * **Windows (Command Prompt):** `ipconfig | findstr /i "ipv4"` + +3. **Create and edit the `.env` file:** + Create a file named `.env` in the same directory as your `docker-compose.yml` and add the following lines, replacing `` and `` with the values you found: + ``` + HOSTNAME= + IP= + PORT=9090 + ``` + +
### Logging In @@ -203,21 +237,6 @@ This allows for a more complex example: - both parents need to be able to access both children's records, and maybe each-others - the caregiver should have view-only access to 1 or both children, but not the parents. -# Mobile application - -In partnership with [LifeValue](https://lifevalue.com), we develop a mobile application: **[HealthWallet.me](https://github.com/TechStackApps/HealthWallet.me)**, that syncs with your **self-hosted Fasten instance**, giving you access to your health records on the mobile. - - - Download on the App Store - - - Get it on Google Play - - -![HealthWallet.me Mobile App](https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/cb77164776cacddc621750394cbd091e90cb14ea/assets/readme/app.gif) - - - # FAQ's See [FAQs](https://docs.fastenhealth.com/faqs.html) for common questions (& answers) regarding Fasten @@ -248,8 +267,8 @@ We use SemVer for versioning. For the versions available, see the tags on this r # Authors -- Jason Kulatunga - Initial Development - @AnalogJ -- Alex Szilagyi - Co-Author - @alexszilagyi +- Jason Kulatunga - Initial Development - [@AnalogJ](https://github.com/AnalogJ) +- Alex Szilagyi - Co-Author - [@alexszilagyi](https://github.com/alexszilagyi) # Licenses From e83fcc3fb39abf0d13cc34dc076085d02db4a2df Mon Sep 17 00:00:00 2001 From: "Beniamin S. @ TSA" Date: Mon, 29 Sep 2025 10:24:04 +0300 Subject: [PATCH 3/3] update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b401a42d..d3af7635b 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ ghcr.io/fastenhealth/fasten-onprem:main ### Companion Mobile App -In partnership with [LifeValue](https://lifevalue.com), we develop an **open-source** mobile application: **[HealthWallet.me](https://healthwallet.me/)** / **[Github repository](https://github.com/TechStackApps/HealthWallet.me)** , that syncs with your **self-hosted Fasten instance**, giving you access to your health records on the mobile. +In partnership with [Life Value](https://lifevalue.com), we develop an **open-source** mobile application: **[HealthWallet.me](https://healthwallet.me/)** / **[Github repository](https://github.com/TechStackApps/HealthWallet.me)** , that syncs with your **self-hosted Fasten instance**, giving you access to your health records on the mobile. @@ -279,7 +279,7 @@ We use SemVer for versioning. For the versions available, see the tags on this r We'd like to thank the following Corporate Sponsors: -LifeValue +LifeValue