deblan/ft-sync
deblan/ft-sync
2
1
Fork 0
Code Issues 2 Pull requests Projects Releases 2 Packages Wiki Activity Actions

update documentation

Browse source
This commit is contained in:
Simon Vieille 2024-08-29 13:39:25 +02:00
commit 01eef4c5f1
1 changed files with 19 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,4 +1,22 @@
# FreeTube sync
# FreeTube Sync
[FreeTube](https://freetubeapp.io/) is an open source desktop YouTube player built with privacy in mind. Use YouTube without advertisements and prevent Google from tracking you with their cookies and JavaScript.
It does not require an account, all datas are on your local storage. In case of you use FreeTube on several computers, you can't synchronize them easily. FreeTube stores datas on plain text files, loaded in memory and rewrite them on each updates.
**FreeTube Sync** tries to solve this problem.
## What are requirements?
**FreeTube Sync** requires a server accessible by all machines running FreeTube (on a local network, through a VPN or on the web).
## How does it work?
The role of the server is to store the history, the playlists and the profiles of FreeTube instances (clients).
After starting the server, each client must init its local datas on the server. This action must be processed only once.
At each time you want to use FreeTube, you have to pull datas from the server before. A watcher will push updates on the server when your history, your playlists or your profiles are updated.
When FreeTube is restarted, history, playlists and profiles will be updated.
```mermaid
sequenceDiagram