Skip to content

docs: update documentation (2026-06-15) #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update documentation (2026-06-15) #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 2 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,24 +98,12 @@ S3_PUBLIC_URL=https://your-public-bucket-url.com
S3_REGION=auto
```

When configured, all new media uploads go to S3 automatically. To migrate existing local media to S3:

```bash
bun server/scripts/migrate-media-to-s3.js
# Add --delete-local to remove local copies after upload
```
When configured, all new media uploads go to S3 automatically.

### Automatic DB backups

When S3 is configured, socialChat will automatically back up the SQLite database to `backups/` in your S3 bucket every Sunday at midnight UTC, keeping the 4 most recent backups.

To restore a backup:

```bash
bun server/scripts/restore-backup.js # restore latest
bun server/scripts/restore-backup.js list # see available backups
bun server/scripts/restore-backup.js db-2026-03-16-a7f3c9d2.sqlite # restore specific
```

## Deployment

Expand All @@ -139,3 +127,4 @@ Any machine with Bun installed works. Point a reverse proxy (nginx, Caddy) at po
## Android Client

A native Android client is available at [usr-wwelsh/socialChatAndroid](https://github.com/usr-wwelsh/socialChatAndroid).