fix: Update documentation and add English versions for all guides [skip ci]
This commit is contained in:
86
server/README.en.md
Normal file
86
server/README.en.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# WebDAV Server - Simple Notes Sync
|
||||
|
||||
**🌍 Languages:** [Deutsch](README.md) · **English**
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Adjust environment variables
|
||||
cp .env.example .env
|
||||
nano .env
|
||||
|
||||
# 2. Start server
|
||||
docker-compose up -d
|
||||
|
||||
# 3. Check logs
|
||||
docker-compose logs -f
|
||||
|
||||
# 4. Test
|
||||
curl -u noteuser:your_password http://localhost:8080/
|
||||
```
|
||||
|
||||
## Server URL
|
||||
|
||||
**Local:** `http://localhost:8080/`
|
||||
|
||||
**On network:** `http://YOUR_IP:8080/` (e.g. `http://192.168.1.100:8080/`)
|
||||
|
||||
Find IP address:
|
||||
```bash
|
||||
ip addr show | grep "inet " | grep -v 127.0.0.1
|
||||
```
|
||||
|
||||
## Credentials
|
||||
|
||||
Default (see `.env`):
|
||||
- Username: `noteuser`
|
||||
- Password: See `.env` file
|
||||
|
||||
## Management
|
||||
|
||||
```bash
|
||||
# Check status
|
||||
docker-compose ps
|
||||
|
||||
# View logs
|
||||
docker-compose logs -f
|
||||
|
||||
# Restart
|
||||
docker-compose restart
|
||||
|
||||
# Stop
|
||||
docker-compose down
|
||||
|
||||
# Update
|
||||
docker-compose pull
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Data Location
|
||||
|
||||
Your notes are stored in: `./data/`
|
||||
|
||||
**Backup:**
|
||||
```bash
|
||||
# Create backup
|
||||
tar -czf notes-backup-$(date +%Y%m%d).tar.gz data/
|
||||
|
||||
# Restore backup
|
||||
tar -xzf notes-backup-YYYYMMDD.tar.gz
|
||||
```
|
||||
|
||||
## External Access (HTTPS)
|
||||
|
||||
For access from outside your home network, use a reverse proxy like Caddy or nginx:
|
||||
|
||||
**Example with Caddy:**
|
||||
|
||||
```Caddyfile
|
||||
notes.yourdomain.com {
|
||||
reverse_proxy localhost:8080
|
||||
}
|
||||
```
|
||||
|
||||
**Important:** Always use HTTPS for external access to protect your credentials!
|
||||
Reference in New Issue
Block a user