📝 Usage tips and backup docs
This commit is contained in:
parent
6128678678
commit
ec1f5db452
11
README.md
11
README.md
@ -42,18 +42,19 @@ Demo is worth a thousand words, head to 📸 [Demo](#Demo).
|
||||
|
||||
If you need help, feel free to open an [issue](https://github.com/itskovacs/trip/issues).
|
||||
|
||||
> [!CAUTION]
|
||||
> :boom: change on Docker volume. If you come from `<1.5.0`, follow the [few steps](https://github.com/itskovacs/trip/releases/tag/1.5.0) to migrate your data.
|
||||
|
||||
```bash
|
||||
# Ensure you have the latest image
|
||||
docker pull ghcr.io/itskovacs/trip:1
|
||||
|
||||
# Run the container
|
||||
docker run -p 8080:8000 -v ./storage:/app/storage ghcr.io/itskovacs/trip:1
|
||||
docker run -d -p 8080:8000 -v ./storage:/app/storage ghcr.io/itskovacs/trip:1
|
||||
```
|
||||
|
||||
If you want to configure OIDC authentication or other settings, see [config docs](https://github.com/itskovacs/trip/tree/main/docs/config.md).
|
||||
Refer to the [configuration documentation](https://github.com/itskovacs/trip/tree/main/docs/config.md) to set up OIDC authentication and other settings.
|
||||
|
||||
> [!TIP]
|
||||
> See [Usage Tips](https://github.com/itskovacs/trip/tree/main/docs/usage_tips.md) in docs for advanced features.
|
||||
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
20
docs/backup.md
Normal file
20
docs/backup.md
Normal file
@ -0,0 +1,20 @@
|
||||
TRIP uses SQLite databases to store the data.
|
||||
|
||||
To back up your data, follow these simple steps:
|
||||
1. **Stop the container**
|
||||
```bash
|
||||
# Look for TRIP container
|
||||
$ docker ps
|
||||
|
||||
$ docker stop <trip_container_id>
|
||||
```
|
||||
|
||||
2. **Copy the SQLite database file**
|
||||
```bash
|
||||
$ cp /path/to/trip/storage/trip.sqlite /path/to/backups/trip.sqlite.bak
|
||||
```
|
||||
|
||||
3. **Restart the container**
|
||||
|
||||
> [!TIP]
|
||||
> To restore your data, simply copy the `trip.sqlite` file back into the `storage` directory.
|
||||
30
docs/usage_tips.md
Normal file
30
docs/usage_tips.md
Normal file
@ -0,0 +1,30 @@
|
||||
|
||||
## Place Creation
|
||||
### Google Maps URL Parsing
|
||||
|
||||
You can paste a link from Google Maps into the `place` input when creating a Place.
|
||||
|
||||
It will automatically fill the `Name`, `Place`, `Latitude` and `Longitude` from the link.
|
||||
|
||||
Try it yourself with this URL: `https://www.google.com/maps/place/British+Museum/@51.5194166,-0.1295315,17z/data=!3m1!4b1!4m6!3m5!1s0x48761b323093d307:0x2fb199016d5642a7!8m2!3d51.5194133!4d-0.1269566`.
|
||||
|
||||
To have this, you can either *click* on a Point of Interest in Google Maps or *search* for one, then copy the URL.
|
||||
|
||||
|
||||
### LatLng Parsing
|
||||
|
||||
You can paste a LatLng coordinate into the `latitude` input when creating a Place.
|
||||
|
||||
Supported formats include examples like:
|
||||
- `37.7749, -122.4194`
|
||||
- `37.7749° N, 122.4194° W`
|
||||
- `37°46'29.64" N, 122°25'9.84" W`
|
||||
- `37°46.494' N, 122°25.164' W`
|
||||
|
||||
## Trip
|
||||
|
||||
### Display a day itinerary
|
||||
|
||||
In addition to displaying the full trip itinerary using the button above the table, you can view the itinerary for a single day by clicking on that day's name in the table.
|
||||
|
||||
This will show only the itinerary for the selected day.
|
||||
Loading…
x
Reference in New Issue
Block a user