From 725e9e1105fae7a6d3b388b806d00d0a8155e667 Mon Sep 17 00:00:00 2001 From: Mario Steele Date: Mon, 21 Jul 2025 13:23:44 -0500 Subject: [PATCH 1/2] Updated Solution Added items for Dockerfile and Readme in solution --- FreeTubeSync.sln | 2 ++ 1 file changed, 2 insertions(+) diff --git a/FreeTubeSync.sln b/FreeTubeSync.sln index e634bc5..29c73d0 100644 --- a/FreeTubeSync.sln +++ b/FreeTubeSync.sln @@ -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 From 977b40c403e5a4c01211730003297d27910cf4c1 Mon Sep 17 00:00:00 2001 From: Mario Steele Date: Mon, 21 Jul 2025 13:23:56 -0500 Subject: [PATCH 2/2] Added Readme Added Read me documentation for the project. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..46dd4c2 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +

+ +

+ +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.