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

  1. Download APK: Latest version

    • Choose: simple-notes-sync-vX.X.X-standard.apk
  2. Allow installation:

    • Android: Settings โ†’ Security โ†’ Enable "Unknown sources" for your browser
  3. Open and install APK


Step 3: Configure App

  1. Open app

  2. Open settings (โš™๏ธ icon top right)

  3. Configure server settings:

    FieldValue
    WebDAV Server URLhttp://YOUR-SERVER-IP:8080/
    Usernamenoteuser
    Password(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.

  4. Press "Test connection"

    • โœ… Success? โ†’ Continue to step 4
    • โŒ Error? โ†’ See Troubleshooting
  5. Enable auto-sync (toggle switch)

  6. 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

  1. Back to main view (โ† arrow)

  2. "Add note" (+ icon)

  3. Enter title and text

  4. Save (๐Ÿ’พ icon)

  5. 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:

  1. Install app (see step 2 above)

  2. Use without server configuration:

    • Notes are only stored locally
    • No auto-sync
    • Perfect for offline-only use

๐Ÿ”‹ Disable Battery Optimization

For reliable auto-sync:

  1. Settings โ†’ Apps โ†’ Simple Notes Sync

  2. Battery โ†’ Battery usage

  3. 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

IntervalSyncs/dayBattery/dayBattery/syncUse 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:

  1. Server running?

    docker compose ps
    # Should show "Up"
    
  2. Same network?

    • Smartphone and server must be on same network
  3. IP address correct?

    ip addr show | grep "inet "
    # Check if IP in URL matches
    
  4. Firewall?

    # Open port 8080 (if firewall active)
    sudo ufw allow 8080/tcp
    
  5. Check server logs:

    docker compose logs -f
    

Auto-sync not working

Problem: Notes are not automatically synchronized

Solutions:

  1. Auto-sync enabled?

    • โš™๏ธ Settings โ†’ Toggle "Auto-sync" must be ON
  2. Battery optimization disabled?

  3. Connected to WiFi?

    • Auto-sync triggers on any WiFi connection
    • Check if you're connected to a WiFi network
  4. 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:

  1. Manually sync once:

    • โš™๏ธ Settings โ†’ "Sync now"
  2. Check server data:

    docker compose exec webdav ls -la /data/
    # Should show .json files
    

Sync errors

Problem: Error message during sync

Solutions:

  1. "401 Unauthorized" โ†’ Wrong password

    • Check password in app settings
    • Compare with .env on server
  2. "404 Not Found" โ†’ Wrong URL

    • Should end with / (e.g. http://192.168.1.100:8080/)
  3. "Network error" โ†’ No connection


๐Ÿ“ฑ Updates

  1. Install Obtainium

  2. Add app:

    • URL: https://github.com/inventory69/simple-notes-sync
    • Enable auto-update
  3. Done! Obtainium notifies you of new versions

Manual

  1. Download new APK from Releases

  2. Install (overwrites old version)

  3. All data remains intact!


๐Ÿ†˜ Further Help


Version: 1.1.0 ยท Created: December 2025