Skip to content

updated readme #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

updated readme #610

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0bdd1fe
updated readme
beniamin-szilagyi Sep 19, 2025
1293913
update
beniamin-szilagyi Sep 22, 2025
e83fcc3
update
beniamin-szilagyi Sep 29, 2025
00c1725
Merge branch 'main' into readme
beniamin-szilagyi Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 82 additions & 52 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,9 @@
</p>

<p align="center">
<a href="https://imgur.com/a/vfgojBD">
<img alt="fasten_view" src="https://i.imgur.com/jfqv5Q5.png">
</a>
<br/>
<a href="https://imgur.com/a/vfgojBD">See more Fasten screenshots</a>
<img alt="Fasten Local Import" src="https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/master/assets/readme/fasten_local_import.gif">
</p>


# 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
Expand Down Expand Up @@ -92,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

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:
### Start Fasten

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 `<your_hostname>` and `<your_ip_address>` with the values you found:
```
HOSTNAME=<your_hostname>
IP=<your_ip_address>
PORT=9090
```

### 🧪 Develop

Use local development settings for testing and iteration.

> ℹ️ **Observation:** Requires a local clone of the repository.

```bash
docker compose up -d
```
Expand All @@ -154,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
Expand All @@ -170,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 [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.


<a href="https://apps.apple.com/app/healthwallet-me/id6748325588">
<img src="https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/refs/heads/master/assets/readme/apple_store.svg" height="60px" alt="Download on the App Store" />
</a>
<a href="https://play.google.com/store/apps/details?id=com.techstackapps.healthwallet">
<img src="https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/refs/heads/master/assets/readme/playstore.svg" height="60px" alt="Get it on Google Play" />
</a>

![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**)


<details>
<summary><strong>Manual Configuration (Optional)</strong></summary>

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 `<your_hostname>` and `<your_ip_address>` with the values you found:
```
HOSTNAME=<your_hostname>
IP=<your_ip_address>
PORT=9090
```

</details>

### Logging In

Expand Down Expand Up @@ -208,7 +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.


# FAQ's

See [FAQs](https://docs.fastenhealth.com/faqs.html) for common questions (& answers) regarding Fasten
Expand Down Expand Up @@ -239,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

Expand All @@ -250,6 +278,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:


<a style="padding-left:5px" href="https://lifevalue.com/"><img src="https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/refs/heads/master/assets/readme/life_value_large.svg" height="100px" alt="LifeValue" /></a>
<a href="https://depot.dev/"><img src="https://raw.githubusercontent.com/fastenhealth/docs/main/img/sponsors/depot.png" height="100px" /></a>
<a style="padding-left:5px" href="https://www.macminivault.com/"><img src="https://raw.githubusercontent.com/fastenhealth/docs/main/img/sponsors/macminivault.png" height="100px" /></a>
<a style="padding-left:5px" href="https://www.browserstack.com/"><img src="https://raw.githubusercontent.com/fastenhealth/docs/main/img/sponsors/browserstack.png" height="100px" /></a>