This repository has been archived on 2022-06-28. You can view files and clone it, but cannot push or open issues or pull requests.
Yotter/README.md

168 lines
12 KiB
Markdown
Raw Normal View History

2020-09-04 15:42:23 +05:30
<p align="center"> <img width="700" src="app/static/img/banner.png"> </img></p>
<p align="center">
2020-09-08 01:51:57 +05:30
<a href="https://www.gnu.org/licenses/gpl-3.0"><img alt="License: GPL v3" src="https://img.shields.io/badge/License-AGPLv3-blue.svg"></img></a>
2020-09-04 15:42:23 +05:30
<a href="https://github.com/pluja/Yotter"><img alt="Development state" src="https://img.shields.io/badge/State-Beta-blue.svg"></img></a>
<a href="https://github.com/pluja/Yotter/pulls"><img alt="Pull Requests Welcome" src="https://img.shields.io/badge/PRs-Welcome-green.svg"></img></a>
</p>
Yotter allows you to follow and gather all the content from your favorite Twitter and YouTube accounts in a *beautiful* feed so you can stay up to date without compromising your privacy at all. Yotter is written with Python and Flask and uses Semantic-UI as its CSS framework.
Yotter is possible thanks to several open-source projects that are listed on the [Powered by](#powered-by) section. Make sure to check out those awesome projects!
2020-09-05 12:44:19 +05:30
# Index:
2020-09-04 15:42:23 +05:30
* [Why](#why)
* [Features](#features)
2020-10-07 12:56:44 +05:30
* [FAQ](#FAQ)
2020-09-04 15:42:23 +05:30
* [Privacy and Security](#privacy)
2020-09-05 12:22:30 +05:30
* [Public instances](#public-instances)
2020-09-19 12:43:03 +05:30
* [Self hosting](https://github.com/ytorg/Yotter/blob/dev-indep/SELF-HOSTING.md)
2020-09-05 19:04:13 +05:30
* [Contributing and contact](#contributing)
2020-09-04 15:42:23 +05:30
* [Powered by](#powered-by)
* [Donate](#donate)
2020-10-07 12:56:44 +05:30
* [Screenshots](#screenshots)
2020-11-05 20:00:51 +05:30
* [Redirect Extensions](#redirect)
2020-09-04 15:42:23 +05:30
2020-09-05 12:44:19 +05:30
# Why
2020-10-07 12:56:44 +05:30
Youtube and Twitter are well-known by their invasive and data-stealing *'privacy policies'*. You give them a **lot** of data; from ideology to music taste, your likes and dislikes, your free-time schedule, and much more than you think. This much data gives such companies a control over you that you would never thought.
2020-09-04 15:42:23 +05:30
2020-10-07 12:56:44 +05:30
With the *particular* data about you, they can get money from the highest bidder and target advertisements. This could seem *not-as-bad* but it gets worse. They can sell this data to some company that, with such knowledge about you, could harm your future in a way you can't imagine. What if you are watching self-help videos on Youtube and this data ends on you insurance hands? Would they raise your fee because they consider you are not *emotionally stable*? We can think of thousands of examples like this, where the data ends in the wrong hands and harms you in an unexpected way.
Further more, they don't care about **what you in particular watch**, this is only sold to the highest bidder who then may or may not do the harm. What they care more about is **what people watch** this is the important data and the one that allows to manipulate, bias, censor, etc.
So we need platforms and spaces where we can freely watch and listen content without these watchful eyes upon us. Ideally, everyone would use a free (as in freedom) and decentralized platform like [Peertube](https://joinpeertube.org/), [LBRY](https://lbry.tv/), [Mastodon](https://joinmastodon.org/) or [Pleroma](https://pleroma.social/) but things are not like this. The main multimedia content factory is Youtube and the microblogging king is Twitter. So we will do whatever is possible to be able to watch and read the content and avoid the surveillance that seeks us these days. We will resist.
2020-09-04 15:42:23 +05:30
2020-09-05 12:44:19 +05:30
# Features:
2020-09-04 15:42:23 +05:30
- [x] No Ads.
2020-09-05 15:03:43 +05:30
- [x] No Javascript needed*
2020-09-04 15:42:23 +05:30
- [x] Minimalist.
- [x] Search on Twitter and Youtube.
- [x] Zero connections to Google/Twitter on the client.
- [x] Follow Twitter accounts.
- [x] Follow Youtube accounts.
2020-09-05 13:31:10 +05:30
- [x] Play Youtube videos on background on Android.
2020-09-20 16:00:18 +05:30
- [x] Play only audio from youtube to save data.
2020-09-04 15:42:23 +05:30
- [x] Save your favourite Tweets.
- [x] Tor-friendly.
- [x] Terminal-browser friendly.
2020-11-09 13:41:43 +05:30
- [x] Fair non-adictive UX - No recommendations, no trending, no tops. Just your feed and your searches.
2020-09-04 15:42:23 +05:30
2020-09-05 15:03:43 +05:30
*Video player is VideoJS, which uses JavaScript. But if JavaScript is disabled Yotter still works perfectly and uses the default HTML video player.
2020-09-04 15:42:23 +05:30
2020-10-07 12:56:44 +05:30
# FAQ
### What's the difference between this and Invidious?
At first I started working on this project as a solution for following Twitter accounts (a thing that can't be done with Nitter) and getting a Twitter-like feed. Weeks later the leader of Invidious, Omar Roth, announced that he was stepping away from the project. As an Invidious active user, this made me think that a new alternative was needed for the community and also an alternative with an easier programmin language for most people (as Invidious is written in Crystal). So I started developing a '*written-in-python Invidious alternative*' and it went quite well.
I hope that this project can prosperate, gain contributors, new instances and create a good community around it.
2020-10-08 14:04:32 +05:30
### Why do I have to register to use Yotter?
Registering has two main reasons:
1. Yotter is in a **beta** state. This means that we will be incrementally increasing the capacity of the servers so we can empirically know how many users a Yotter server can handle. Also, there is no **big server** with capacity for handling any arbitrary ammount of users and serving video/data to those at the moment. For this, we decided to have a registration form so we could limit the users.
2. Yotter allows users to follow accounts and have a custom feed. This needs an account to save your followed users and generate a feed.
Admins are allowed to remove restrictions on any page they want. [Check this section](https://github.com/ytorg/Yotter/blob/dev-indep/SELF-HOSTING.md#removing-log-in-restrictions) to learn how.
2020-11-03 13:51:22 +05:30
If you want to use Yotter, it is recommended to self-host your own instance. You can use it for personal use or open it to the world. Self-hosting makes Yotter stronger and gives you full power. See [self hosting guide](https://github.com/ytorg/Yotter/blob/dev-indep/SELF-HOSTING.md).
2020-11-11 16:30:51 +05:30
### Will you ever implement video recomendations, trendig videos, etc?
No. From my point of view, these are toxic features. I, and every user, should be using all *social media* to get the content **they** want. Recomendations, trending, autoplay next video, etc. are all features designed to trap users on using the app, to make them forget about the time spent there and to create an addiction to it. No, I won't implement any toxic features on Yotter. Yotter will keep the UI clean, fast and simple.
You get your feed from followed accounts and you can search for any video you like. Only thing I would consider implementing would be some kind of page where you can ask for recommendations for a particular video. This way the user would, voluntarily, ask for the recommendations rather than having a temptation to click on a new, youtube-bias-recommended video.
Please read: [1](https://arxiv.org/abs/1912.11211), [2](https://medium.com/dataseries/how-youtube-is-addictive-259d5c575883), [3](https://www.their.tube/), [4](https://www.sciencedirect.com/science/article/pii/S1386505619308743?via%3Dihub)
2020-09-05 12:44:19 +05:30
# Privacy
2020-09-04 15:42:23 +05:30
#### Connections
Yotter cares about your privacy, and for this it will never make any connection to Twitter or Youtube on the client. Every request is proxied through the Yotter server; video streaming, photos, data gathering, scrapping, etc.
The Yotter server connects to Google (Youtube) and Nitter in order to gather all the necessary data. Then it serves it (proxyed through itself) to the client. This means that as a client, you will never connect to Google/Youtube/Twitter - the Yotter server will do it for you. So if you want to set up a Yotter server for privacy reasons I recommend you to set it up on a remote VPS so you don't share your IP with, or use a VPN on the server.
2020-09-04 15:42:23 +05:30
If you don't mind exposing your IP making requests to Google then you can set it up wherever you want. Even with this method you will **avoid all trackers, ads, heavy-loaded pages, etc**. - you can still stay safe if you use a VPN to hide your IP.
2020-09-04 15:42:23 +05:30
#### Your data
The only things the database stores are:
2020-10-07 13:03:21 +05:30
* Salted hash of the password
2020-09-04 15:42:23 +05:30
* Username
* List of followed users
* List of saved posts
* Some user configurations
2020-09-04 15:42:23 +05:30
This data will never be used for any other purpose than offering the service to the user. It's not sent anywhere, never.
#### Security
2020-10-07 13:03:21 +05:30
Only the salted hash of your password is stored in the database, so no admin can see or guess your plain-text password ever. Also, no personal information of any kind is required nor kept, if a hacker gets access to the database the only thing they could do would be to follow/unfollow some accounts. So there's no motivation in 'hacking' Yotter.
2020-09-04 15:42:23 +05:30
I always recommend self-hosting, as you will be the only person with access to your data.
2020-09-04 15:42:23 +05:30
> Important note: The **client** never connects to Google / Youtube however, the server does in order to gather all the necessary things!
2020-09-05 12:44:19 +05:30
# Public Instances
2020-10-11 02:03:15 +05:30
| Name |Server location|Status & Register|
2020-10-11 02:04:08 +05:30
| ------------ | ------------ | ------------ |
2020-10-11 02:03:15 +05:30
| https://yotter.xyz/ |Germany| [Go](https://yotter.xyz/status)|
| https://yotter.kavin.rocks/ |India| [Go](https://yotter.kavin.rocks/status)|
| https://yotter.jank.media/ |Germany| [Go](https://yotter.jank.media/status)|
2020-09-05 12:22:30 +05:30
2020-09-05 18:11:59 +05:30
# Contributing
Contributors are always welcome. You can help in many ways: Coding, organizing, designing, [donating](#donate), maintaining... You choose what you want to help with!
We have a [Matrix](https://matrix.org/) room where we discuss anything related with Yotter, feel free to enter the room and start talking or reading. You can choose a Matrix client from [this list of Matrix clients](https://matrix.org/clients/). Also you will need to choose an instance to host your account, you can find Matrix instances [here](https://www.hello-matrix.net/public_servers.php).
<a href="https://matrix.to/#/!wqJnbUtEfitxtOsLFj:privacytools.io?via=privacytools.io&via=matrix.org"><img alt="Join Matrix" src="https://img.shields.io/badge/Join Room-Matrix-black.svg">
2020-09-05 19:04:13 +05:30
#### Other platforms:
<a href="https://reddit.com/r/Yotter"><img alt="Join Matrix" src="https://img.shields.io/badge/Reddit-r/Yotter-orange.svg">
2020-09-05 18:11:59 +05:30
2020-09-05 12:44:19 +05:30
# Powered by:
2020-10-11 01:04:19 +05:30
These are projects that either make Yotter possible as an **essential part** of it or that served as **inspiration for some parts** of the code.
2020-10-05 21:51:11 +05:30
2020-09-04 15:42:23 +05:30
* [Nitter](https://nitter.net/)
2020-10-11 01:04:19 +05:30
* [Youtube-local](https://github.com/user234683/youtube-local)
2020-11-01 22:57:55 +05:30
* [youtube-dlc](https://github.com/blackjack4494/yt-dlc)
2020-09-04 15:42:23 +05:30
* [Flask](https://flask.palletsprojects.com/)
* [SQLAlchemy](https://docs.sqlalchemy.org/en/13/)
* [Semantic-UI](https://semantic-ui.com)
* [requests-futures](https://github.com/ross/requests-futures)
* [microblog](https://github.com/miguelgrinberg/microblog)
* [Video.js](https://videojs.com/)
2020-10-05 21:51:11 +05:30
* [Invidious](https://github.com/iv-org/invidious)
2020-09-04 15:42:23 +05:30
2020-09-05 12:44:19 +05:30
# Donate
2020-09-04 15:42:23 +05:30
This project is completely free and Open Source and will always be.
2020-11-04 13:27:59 +05:30
Donations are used to mantain the [yotter.xyz](https://yotter.xyz/) public instance. [This is the server](https://www.netcup.eu/bestellen/produkt.php?produkt=2598) that I have rented for now.
2020-10-07 12:56:44 +05:30
2020-11-01 22:56:08 +05:30
#### Crypto:
##### Preferred
2020-09-05 16:10:14 +05:30
- **Bitcoin**: `bc1q5y3g907ju0pt40me7dr9fy5uhfhfgfv9k3kh3z`
2020-09-05 16:11:14 +05:30
- **Monero**: `48nQGAXaC6eFK2Wo7SVVyF9xL333gDHjzdmRL3XETEqbU3w4CcKjjHVUZPU4W3dg1oJL8be3iGtUAQsgV88dzbS7QNpZjC2`
2020-11-01 22:56:08 +05:30
##### Others:
- **Ethereum**: `0x6cf0B1C3354c255F1a876f4833A1BBE82D887Ad6`
- **Litecoin**: `MHjnpYHwu4y4AeQvVBDv52T8V6BzVxmiNZ`
- **ZCash**: `t1a6smU9a6dxGfZWcX9bCRzE31qsaF27FsD`
2020-09-04 15:42:23 +05:30
#### Fiat:
- <a href="https://liberapay.com/pluja/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>
## Screenshots
2020-11-11 17:09:05 +05:30
<p align="center"> <img width="720" src="https://i.imgur.com/tA15ciH.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/BYswFy6.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/KalBDa5.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/rHsKl0e.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/pQhLcvI.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/kZPGUdq.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/zybRB7X.png"> </img></p>
<p align="center"> <img width="720" src="https://i.imgur.com/XHCSNTP.png"> </img></p>
2020-11-05 20:00:51 +05:30
## Redirect
If you want to worry less and enjoy Yotter more, you can use any of the following extensions to redirect Youtube to Yotter automatically:
* [Youtter](https://addons.mozilla.org/en-US/firefox/addon/youtter/?utm_source=addons.mozilla.org&utm_medium=referral&utm_content=search) - Firefox
* [Privacy Redirect](https://addons.mozilla.org/en-US/firefox/addon/youtter/?utm_source=addons.mozilla.org&utm_medium=referral&utm_content=search) - Chromium
* Set Yotter as a Invidious instance on extension options.
* [HTTPSEverywhere](https://www.eff.org/https-everywhere) - Both
* You can set up redirects. Use a "http://youtube.com/ -> https://yotterinstance.xyz/" redirect.