Cleanup
This commit is contained in:
39
README.md
39
README.md
@@ -2,21 +2,6 @@
|
||||
|
||||
This is a FOSS app meant to help climbers track their sessions, routes/problems, and overall progress. This app is offline-only and requires no special permissions to run. Its built using Jetpack Compose with Material You support on Android and SwiftUI on iOS.
|
||||
|
||||
## Versions
|
||||
|
||||
- Android: 1.7.0
|
||||
- iOS: 1.2.0
|
||||
- Sync: 1.0.0
|
||||
|
||||
## Stability
|
||||
- Clients: 8/10
|
||||
- Server: 10/10
|
||||
- Schema: 9/10 (No more breaking changes)
|
||||
|
||||
## Self-Hosted Sync Server
|
||||
|
||||
You can run your own sync server to keep your data in sync across devices. The server is lightweight and easy to set up. See the server docker-compose file for an example.
|
||||
|
||||
## Download
|
||||
|
||||
For Android do one of the following:
|
||||
@@ -28,6 +13,30 @@ For iOS:
|
||||
|
||||
Download from the AppStore [here](https://apps.apple.com/ca/app/openclimb/id6752592783)!
|
||||
|
||||
## Self-Hosted Sync Server
|
||||
|
||||
You can run your own sync server to keep your data in sync across devices. The server is lightweight and easy to set up using Docker.
|
||||
|
||||
### Quick Start with Docker Compose
|
||||
|
||||
1. Create a `.env` file with your configuration:
|
||||
```
|
||||
IMAGE=git.atri.dad/atridad/openclimb-sync:latest
|
||||
APP_PORT=8080
|
||||
AUTH_TOKEN=your-secure-auth-token-here
|
||||
DATA_FILE=/data/openclimb.json
|
||||
IMAGES_DIR=/data/images
|
||||
ROOT_DIR=./openclimb-data
|
||||
```
|
||||
|
||||
2. Use the provided `docker-compose.yml` in the `sync/` directory:
|
||||
```bash
|
||||
cd sync/
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
The server will be available at `http://localhost:8080`. Configure your clients with your server URL and auth token to start syncing.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Android 12+ or iOS 17+
|
||||
|
||||
Reference in New Issue
Block a user