Added Readme
Added Read me documentation for the project.
This commit is contained in:
parent
725e9e1105
commit
977b40c403
1 changed files with 31 additions and 0 deletions
31
README.md
Normal file
31
README.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
<p align="center">
|
||||
<img alt="" src="https://raw.githubusercontent.com/FreeTubeApp/FreeTube/refs/heads/development/_icons/logoColor.svg" width=500 align="center">
|
||||
</p>
|
||||
|
||||
FreeTubeSync is an Open API, Single User, synchronization REST server to allow for synchronization of data
|
||||
between machines.
|
||||
|
||||
## What you can sync:
|
||||
* Watch History
|
||||
* Profiles / Subscriptions
|
||||
* Settings
|
||||
* Playlists
|
||||
* Search History
|
||||
|
||||
# Setup
|
||||
|
||||
To setup the API server, simple create a docker compose file with contents below, and run docker `compose up -d`
|
||||
|
||||
```yaml
|
||||
services:
|
||||
freetubesync:
|
||||
image: forge.eumario.dev/eumario/freetubesync:latest
|
||||
ports:
|
||||
- "8080:8080"
|
||||
volumes:
|
||||
- ./data:/data
|
||||
```
|
||||
|
||||
This project is currently only setup to be a Single User instance, no login/account system currently
|
||||
exists within the project setup. If you want Multi-User support, it's best to create multiple docker
|
||||
containers for each user you want to have this capability for.
|
||||
Loading…
Add table
Add a link
Reference in a new issue