gsadmin/KoalaSync
1
0
Fork 0
mirror of https://github.com/Shik3i/KoalaSync.git synced 2026-08-09 10:49:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(website): update Caddyfile configuration and website README for www/ path

Browse Source 
- Corrected static server root path to website/www/ in Caddyfile.example and website/README.md.
- Updated core roles to reflect multi-language (EN/DE/FR/ES/PT-BR/RU) support.
- Refactored local development and compilation instructions to target build.js and www/ output.
This commit is contained in:
Koala
2026-05-31 23:50:49 +02:00
parent 57b0dd1632
commit 5a3f1c7019
2 changed files with 15 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Caddyfile.example
+1 -1
View File
@@ -3,7 +3,7 @@
# 1. Marketing Website & Invitation Bridge
sync.koalastuff.net {
root * /var/www/koalasync/website
root * /var/www/koalasync/website/www
file_server
encode zstd gzip
website/README.md
+14 -6
View File
@@ -5,7 +5,7 @@ This directory contains the KoalaSync website. It serves a dual purpose: it is b
## Core Roles
### 1. Marketing & Onboarding
Provides a premium, bilingual (EN/DE) overview of features, setup instructions, and direct links to the extension stores.
Provides a premium, multi-language (EN/DE/FR/ES/PT-BR/RU) overview of features, setup instructions, and direct links to the extension stores.
### 2. The Invitation Bridge (`join.html`)
The website handles incoming invitation links. When a user clicks a link like `sync.koalastuff.net/join.html#join:roomID:pass`, the website:
@@ -16,7 +16,8 @@ The website handles incoming invitation links. When a user clicks a link like `s
## Architecture
The website is 100% **Static HTML, CSS, and JS**.
- **Zero Backend**: No Node.js, PHP, or databases are required to host the website.
- **Static i18n Compiler**: The site uses a lightweight, zero-dependency Node.js compiler (`build.js`) to parse dictionary files inside `/locales/` against a single source-of-truth template (`template.html`), outputting the fully deployable static folder to `/www/`.
- **Zero Backend**: No Node.js, PHP, or databases are required to host the compiled website.
- **Zero Tracking**: All assets (fonts, icons) are self-hosted to prevent third-party tracking.
- **Responsive**: Fully optimized for mobile with a native-feel hamburger menu.
@@ -30,7 +31,7 @@ For a more comprehensive configuration that includes the Relay Server reverse pr
```caddy
sync.koalastuff.net {
root * /var/www/koalasync/website
root * /var/www/koalasync/website/www
file_server
encode zstd gzip
@@ -56,7 +57,14 @@ sync.koalastuff.net {
}
```
## Local Development
## Local Development & Compilation
1. Open `index.html` directly in any browser.
2. To test the invitation flow locally, use a local server (e.g., `npx serve .`) and navigate to `http://localhost:5000/join.html#join:test-room:test-pass`.
1. Run the compilation script from the repository root to generate the `/website/www` folder:
```bash
node website/build.js
```
2. Serve the compiled `/www` directory using any local development server:
```bash
npx serve website/www
```
3. To test the invitation flow locally, navigate to `http://localhost:5000/join.html#join:test-room:test-pass`.