Skip to content

Commit 1293913

Browse files
beniamin-szilagyibeniamin-szilagyi
committed
update
1 parent 0bdd1fe commit 1293913

File tree

1 file changed

+79
-60
lines changed

1 file changed

+79
-60
lines changed

‎README.md‎

Lines changed: 79 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -87,58 +87,26 @@ First, if you don't have Docker installed on your computer, get Docker by follow
8787
Next, run the following commands from the Windows command line or Mac/Linux terminal in order to download and start the Fasten docker container.
8888

8989

90+
## 🚀 Launch
9091

91-
### 🚀 Launch
92+
### Start Fasten
9293

93-
Launch the application. Please choose a location where `docker-compose.yml` and `set_env.sh` will be downloaded.
94-
95-
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.
96-
97-
Here are the step-by-step instructions:
98-
99-
1. **Download necessary files:**
94+
1. **Download necessary file:**
10095
```bash
10196
curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/docker-compose-prod.yml -o docker-compose.yml
102-
curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/set_env.sh -o set_env.sh
103-
```
104-
105-
2. **Prepare and run the environment setup script:**
106-
Make the script executable and run it to generate your `.env` file. This will configure network variables required for Docker Compose.
107-
```bash
108-
chmod +x ./set_env.sh
109-
./set_env.sh
11097
```
11198

112-
3. **Start the application:**
99+
2. **Start the application:**
113100
```bash
114101
docker compose up -d
115102
```
116103

117-
**Manual Configuration (Optional)**
118-
119-
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:
120-
121-
1. **Find your hostname:**
122-
```bash
123-
hostname
124-
```
125-
2. **Find your local IP address:**
126-
* **macOS:** `ifconfig | grep "inet " | grep -v 127.0.0.1 | cut -d' ' -f2`
127-
* **Linux:** `hostname -I | awk '{print $1}'`
128-
* **Windows (Command Prompt):** `ipconfig | findstr /i "ipv4"`
129-
130-
3. **Create and edit the `.env` file:**
131-
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:
132-
```
133-
HOSTNAME=<your_hostname>
134-
IP=<your_ip_address>
135-
PORT=9090
136-
```
137-
138104
### 🧪 Develop
139105

140106
Use local development settings for testing and iteration.
141107

108+
> ℹ️ **Observation:** Requires a local clone of the repository.
109+
142110
```bash
143111
docker compose up -d
144112
```
@@ -149,11 +117,11 @@ docker compose up -d
149117
make serve-docker
150118
```
151119

152-
ℹ️ Requires a local clone of the repository.
153-
154120
> ⚠️ **Warning:** Do not run both `docker compose up -d` / `(make serve-docker)` simultaneously. Choose one based on your deployment scenario.
155121

156-
### Optional
122+
Next, open a browser to `http://localhost:9090`
123+
124+
### (Optional) Direct start Fasten using docker run
157125

158126
```
159127
docker pull ghcr.io/fastenhealth/fasten-onprem:main
@@ -165,9 +133,75 @@ docker run --rm \
165133
ghcr.io/fastenhealth/fasten-onprem:main
166134
```
167135
168-
Next, open a browser to `http://localhost:9090`
169136
170-
At this point you'll be redirected to the login page.
137+
### Companion Mobile App
138+
139+
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.
140+
141+
142+
<a href="https://apps.apple.com/app/healthwallet-me/id6748325588">
143+
<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" />
144+
</a>
145+
<a href="https://play.google.com/store/apps/details?id=com.techstackapps.healthwallet">
146+
<img src="https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/refs/heads/master/assets/readme/playstore.svg" height="60px" alt="Get it on Google Play" />
147+
</a>
148+
149+
![HealthWallet.me Mobile App](https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/cb77164776cacddc621750394cbd091e90cb14ea/assets/readme/app.gif)
150+
151+
152+
153+
### Start Fasten (discovarable on your local network)
154+
155+
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.
156+
157+
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.
158+
159+
Launch the application. Please choose a location where `docker-compose.yml` and `set_env.sh` will be downloaded.
160+
161+
162+
#### **Quick Setup:**
163+
164+
1. **Download necessary files**
165+
```bash
166+
curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/docker-compose-prod.yml -o docker-compose.yml && \
167+
curl https://raw.githubusercontent.com/fastenhealth/fasten-onprem/refs/heads/main/set_env.sh -o set_env.sh && \
168+
chmod +x ./set_env.sh && \
169+
./set_env.sh
170+
```
171+
2. **Start the application:**
172+
```bash
173+
docker compose up -d
174+
```
175+
176+
- **Commands Breakdown**
177+
- Downloads necessary files (**docker-compose.yml** and **set_env.sh**)
178+
- The environment script automatically assigns your local IP so **Fasten** can be available on **your local network**
179+
- Starts the Fasten application (**docker-compose up -d**)
180+
181+
182+
<details>
183+
<summary><strong>Manual Configuration (Optional)</strong></summary>
184+
185+
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:
186+
187+
1. **Find your hostname:**
188+
```bash
189+
hostname
190+
```
191+
2. **Find your local IP address:**
192+
* **macOS:** `ifconfig | grep "inet " | grep -v 127.0.0.1 | cut -d' ' -f2`
193+
* **Linux:** `hostname -I | awk '{print $1}'`
194+
* **Windows (Command Prompt):** `ipconfig | findstr /i "ipv4"`
195+
196+
3. **Create and edit the `.env` file:**
197+
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:
198+
```
199+
HOSTNAME=<your_hostname>
200+
IP=<your_ip_address>
201+
PORT=9090
202+
```
203+
204+
</details>
171205

172206
### Logging In
173207

@@ -203,21 +237,6 @@ This allows for a more complex example:
203237
- both parents need to be able to access both children's records, and maybe each-others
204238
- the caregiver should have view-only access to 1 or both children, but not the parents.
205239

206-
# Mobile application
207-
208-
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.
209-
210-
<a href="https://apps.apple.com/app/healthwallet-me/id6748325588">
211-
<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" />
212-
</a>
213-
<a href="https://play.google.com/store/apps/details?id=com.techstackapps.healthwallet">
214-
<img src="https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/refs/heads/master/assets/readme/playstore.svg" height="60px" alt="Get it on Google Play" />
215-
</a>
216-
217-
![HealthWallet.me Mobile App](https://raw.githubusercontent.com/TechStackApps/HealthWallet.me/cb77164776cacddc621750394cbd091e90cb14ea/assets/readme/app.gif)
218-
219-
220-
221240
# FAQ's
222241

223242
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
248267

249268
# Authors
250269

251-
- Jason Kulatunga - Initial Development - @AnalogJ
252-
- Alex Szilagyi - Co-Author - @alexszilagyi
270+
- Jason Kulatunga - Initial Development - [@AnalogJ](https://github.com/AnalogJ)
271+
- Alex Szilagyi - Co-Author - [@alexszilagyi](https://github.com/alexszilagyi)
253272

254273
# Licenses
255274

0 commit comments

Comments
 (0)