Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
name: Test if TypeScript web app runs

on:
push:
pull_request:

jobs:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ lerna-debug.log*
node_modules
node_modules/
node_modules/*
package-lock.json
dist
dist-ssr
*.local
Expand Down
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,26 +45,27 @@ This can take several minutes depending of your internet connexion.
After installation, you can start QuestHelper by executing:

```bash
npm run dev
npm run app
```

This will start the QeustHelper server, which you can access at [http://localhost:8082](http://localhost:8082)
This will start the QuestHelper server, which you can access at [http://localhost:8082](http://localhost:8082)


## 🐳 Configure QuestHelper as a service

## Configuration

By default, the app runs on `::` (all interfaces) and port `8082`. You can customize both settings using environment variables:
You can customize settings using environment variables:

| Variable | Purpose |
|----------|---------|
| `QUESTHELPER_HOST` | Set the host address |
| `QUESTHELPER_PORT` | Set the port number |
| Variable | Purpose | Default Value |
|----------|---------|---------|
| `QSTH_HOST` | Set the host address | `::` |
| `QSTH_PORT` | Set the port number | `8082` |
| `QSTH_DEFAULT_VERSION` | Set the default version of the App | `v1` |

**Example:**
```bash
QUESTHELPER_HOST='0.0.0.0' QUESTHELPER_PORT=3000 npm run dev
QUESTHELPER_HOST='0.0.0.0' QUESTHELPER_PORT=3000 QSTH_DEFAULT_VERSION='v3' npm run app
```

Since the app only uses the root `/` path, you can safely use a custom domain or reverse proxy without conflicts.
Expand Down
Loading