Compare commits

...

2 commits

Author SHA1 Message Date
977b40c403 Added Readme
Added Read me documentation for the project.
2025-07-21 13:23:56 -05:00
725e9e1105 Updated Solution
Added items for Dockerfile and Readme in solution
2025-07-21 13:23:44 -05:00
2 changed files with 33 additions and 0 deletions

View file

@ -5,6 +5,8 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{47A66AFA-4FD3-40F3-ADE0-27EE0527211B}"
ProjectSection(SolutionItems) = preProject
compose.yaml = compose.yaml
Dockerfile = Dockerfile
README.md = README.md
EndProjectSection
EndProject
Global

31
README.md Normal file
View 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.