Quick Start Guide - Simple Notes Sync ๐
February 25, 2026 ยท View on GitHub
Step-by-step installation and setup guide
๐ Languages: Deutsch ยท English
Prerequisites
- โ Android 7.0+ smartphone/tablet
- โ WiFi connection
- โ Own server with Docker (optional - for self-hosting)
Option 1: With own server (Self-Hosted) ๐
Step 1: Setup WebDAV Server
On your server (e.g. Raspberry Pi, NAS, VPS):
# Clone repository
git clone https://github.com/inventory69/simple-notes-sync.git
cd simple-notes-sync/server
# Configure environment variables
cp .env.example .env
nano .env
Adjust in .env:
WEBDAV_PASSWORD=your-secure-password-here
Start server:
docker compose up -d
Find IP address:
ip addr show | grep "inet " | grep -v 127.0.0.1
โก๏ธ Note down: http://YOUR-SERVER-IP:8080/
Step 2: Install App
-
Download APK: Latest version
- Choose:
simple-notes-sync-vX.X.X-standard.apk
- Choose:
-
Allow installation:
- Android: Settings โ Security โ Enable "Unknown sources" for your browser
-
Open and install APK
Step 3: Configure App
-
Open app
-
Open settings (โ๏ธ icon top right)
-
Configure server settings:
Field Value WebDAV Server URL http://YOUR-SERVER-IP:8080/Username noteuserPassword (your password from .env)๐ก Note: Enter only the base URL (without
/notes). The app automatically creates/notes/for JSON files and/notes-md/for Markdown export. -
Press "Test connection"
- โ Success? โ Continue to step 4
- โ Error? โ See Troubleshooting
-
Enable auto-sync (toggle switch)
-
Choose sync interval:
- 15 min - Maximum currency (~0.8% battery/day)
- 30 min - Recommended (~0.4% battery/day) โญ
- 60 min - Maximum battery life (~0.2% battery/day)
Step 4: Create First Note
-
Back to main view (โ arrow)
-
"Add note" (+ icon)
-
Enter title and text
-
Save (๐พ icon)
-
Wait for auto-sync (or manually: โ๏ธ โ "Sync now")
๐ Done! Your notes will be automatically synchronized!
Option 2: Local notes only (no server) ๐ฑ
You can also use Simple Notes without a server:
-
Install app (see step 2 above)
-
Use without server configuration:
- Notes are only stored locally
- No auto-sync
- Perfect for offline-only use
๐ Disable Battery Optimization
For reliable auto-sync:
-
Settings โ Apps โ Simple Notes Sync
-
Battery โ Battery usage
-
Select: "Don't optimize" or "Unrestricted"
๐ก Note: Android Doze Mode may still delay sync in standby (~60 min). This is normal and affects all apps.
๐ Sync Intervals in Detail
| Interval | Syncs/day | Battery/day | Battery/sync | Use case |
|---|---|---|---|---|
| 15 min | ~96 | ~0.8% (~23 mAh) | ~0.008% | โก Maximum currency (multiple devices) |
| 30 min | ~48 | ~0.4% (~12 mAh) | ~0.008% | โ Recommended - balanced |
| 60 min | ~24 | ~0.2% (~6 mAh) | ~0.008% | ๐ Maximum battery life |
๐ Troubleshooting
Connection test fails
Problem: "Connection failed" during test
Solutions:
-
Server running?
docker compose ps # Should show "Up" -
Same network?
- Smartphone and server must be on same network
-
IP address correct?
ip addr show | grep "inet " # Check if IP in URL matches -
Firewall?
# Open port 8080 (if firewall active) sudo ufw allow 8080/tcp -
Check server logs:
docker compose logs -f
Auto-sync not working
Problem: Notes are not automatically synchronized
Solutions:
-
Auto-sync enabled?
- โ๏ธ Settings โ Toggle "Auto-sync" must be ON
-
Battery optimization disabled?
-
Connected to WiFi?
- Auto-sync triggers on any WiFi connection
- Check if you're connected to a WiFi network
-
Test manually:
- โ๏ธ Settings โ "Sync now"
- Works? โ Auto-sync should work too
Notes not showing up
Problem: After installation, no notes visible even though they exist on server
Solution:
-
Manually sync once:
- โ๏ธ Settings โ "Sync now"
-
Check server data:
docker compose exec webdav ls -la /data/ # Should show .json files
Sync errors
Problem: Error message during sync
Solutions:
-
"401 Unauthorized" โ Wrong password
- Check password in app settings
- Compare with
.envon server
-
"404 Not Found" โ Wrong URL
- Should end with
/(e.g.http://192.168.1.100:8080/)
- Should end with
-
"Network error" โ No connection
๐ฑ Updates
Automatic with Obtainium (recommended)
-
Add app:
- URL:
https://github.com/inventory69/simple-notes-sync - Enable auto-update
- URL:
-
Done! Obtainium notifies you of new versions
Manual
-
Download new APK from Releases
-
Install (overwrites old version)
-
All data remains intact!
๐ Further Help
- GitHub Issues: Report problem
- Complete docs: DOCS.md
- Server setup details: server/README.md
Version: 1.1.0 ยท Created: December 2025