poke/README.md

196 lines
6.2 KiB
Markdown
Raw Normal View History

2024-02-28 17:05:04 +01:00
2023-08-04 23:28:25 +02:00
<h1 align="center">
2022-12-24 13:59:34 +01:00
<a href="https://poketube.fun/watch?v=9sJUDx7iEJw&quality=medium&=sjohgteojgytrueugtye4jhtytjrjnyıı">
2023-11-03 16:52:32 +01:00
<img src="https://poketube.fun/css/logo-poke.svg" width="400">
2024-01-18 18:25:24 +01:00
<a href="http://www.defectivebydesign.org/drm-free">
<img src="https://static.fsf.org/dbd/label/DRM-free%20label%20120.en.png"
alt="DefectiveByDesign.org"
width="65" height="65" border="0" align="middle" /></a>
2023-08-04 23:28:25 +02:00
</a>
2023-11-03 16:52:32 +01:00
<p>The Ultimate Privacy App</p>
2023-10-28 14:13:56 +02:00
</h1>
2024-01-18 18:25:24 +01:00
2023-08-04 23:28:25 +02:00
<div align="center">
2024-01-18 07:16:18 +01:00
<span> Be Anonymous watching epic videos, searching thingys on the interwebs and listening to music on poke - the free privacy front end!</span>
<span>"Since you work on poke, Are you in touch with its lead developer "Jose marchasi"? <br>
-RMS
Stallman though poke was GNU poke lmaoooo
</span>
</div>
2023-10-28 14:13:56 +02:00
<div align="center">
2023-11-30 12:05:12 +01:00
[Welcome!](#welcome)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Features](#features)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[No non-free codec needed](#no-non-free-codec-needed-3)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Hosting Poke~](#hosting-poketube)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Poke community!](#poketube-community)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[The Legal Stuff (boring tbh)](#the-legal-stuff-boring-tbh)
2022-08-25 13:34:00 +02:00
2023-11-04 18:45:31 +01:00
<a href="https://status.poketube.fun" target="_blank">
<img
width="170"
src="https://api.netweak.com/status-badges/K2LY9"
alt="Netweak status badge"
/>
2024-02-28 17:05:04 +01:00
</a><br>
2023-08-04 23:28:25 +02:00
<a href="https://tosdr.org/en/service/7114">
<img src="https://shields.tosdr.org/en_7114.svg"/>
</a>
2023-10-28 14:13:56 +02:00
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg"> <a href="./LICENSE"><img src="https://img.shields.io/badge/License-GPL--3-FF6666" alt="License - GPL-3"></a>
2023-08-04 23:28:25 +02:00
</div>
2024-05-01 05:07:06 +02:00
![Preview](./css/README_Preview.png)
2023-08-04 23:28:25 +02:00
## Welcome!
2024-01-05 17:30:24 +01:00
This is the source code of Poke (formerly PokeTube), the privacy-friendly youtube front-end built with the InnerTube API!
2023-10-28 10:57:28 +02:00
2024-05-01 05:07:06 +02:00
# Features
2023-10-28 10:57:28 +02:00
2024-05-01 08:27:27 +02:00
| <img width="100%" style="border-radius: 24px" src="./css/README_RYD.png"> | <div style="text-align: left"><h3>Return YouTube Dislikes Built-In</h3>See the dislikes from returnyoutubedislike! </div> |
2024-05-01 05:07:06 +02:00
| - | - |
2024-05-01 08:27:27 +02:00
| <div style="text-align: right"><h3>PWA Support</h3> With PWA Support, you can install Poke on your mobile device :3</div> | <img width="100%" style="border-radius: 24px" src="./css/README_PWA.jpg"> |
2023-10-28 10:57:28 +02:00
<h3>Customize</h3>
Customize Poketube However you want :3
<h3>Accounts </h3>
Suscribe (yes Suscribe hehe sussy baka) to whaever channel you want!
<h3>Web Search </h3>
Search the web privatly on poketube :3
2023-10-28 14:13:56 +02:00
<br>
<h3>And... </h3>
<p>
Ambient mode, HQ audio And Even more!!!!!
</p>
2023-10-07 11:55:21 +02:00
## Written by humans - not gpt
2023-11-30 12:05:12 +01:00
poke is made by hard-working hoomans - not gpt :3<br>
2023-10-18 06:34:31 +02:00
<a href="https://notbyai.fyi"><img src="https://cdn.glitch.global/d68d17bb-f2c0-4bc3-993f-50902734f652/Written-By-Human-Not-By-AI-Badge-white.svg?v=1696672202901" alt="Written by Humanss, Not by AI"></a>
2023-10-07 11:55:21 +02:00
2023-03-04 21:48:39 +01:00
## No Non-free codec needed :3
2023-08-04 23:28:25 +02:00
2023-11-30 12:05:12 +01:00
Poke uses openh264 which is free software! poketube does not inculude non free stuff owowowoow!!!!
2023-03-04 21:48:39 +01:00
2023-08-04 23:28:25 +02:00
you can view the source code of the openh264 codec in this repo :3 --> https://github.com/cisco/openh264.git
2023-03-04 21:49:27 +01:00
2023-03-07 20:57:11 +01:00
PLEASE NOTE THAT THIS SOFTWARE MAY INCULUDE CODECS THAT IN CERTAIN COUNTRIES MAY BE COVERED BY PATENTS OR HAVE LEGAL ISSUES. PATENT AND COPYRIGHT LAWS OPERATE DIFFERENTLY DEPENDING ON WHICH COUNTRY YOU ARE IN. PLEASE OBTAIN LEGAL ADVICE IF YOU ARE UNSURE WHETHER A PARTICULAR PATENT OR RESTRICTION APPLIES TO A CODEC YOU WISH TO USE IN YOUR COUNTRY.
2023-11-30 12:05:12 +01:00
## Hosting Poke~
2024-02-16 18:00:55 +01:00
### IMPORTANT
Before you host, if ur server is in usa, set the proxylocation to `USA` (which is the default) - if you use any eu server set it to `EU` instead to make videos load faster
### With NodeJS
2024-05-01 08:27:27 +02:00
To self host your own Poke instance, you'll need some packages installed on your GNU/Linux install.
2024-05-01 05:07:06 +02:00
<details>
<summary>For Fedora/RHEL/Rocky/CentOS</summary>
<br/>
2022-08-09 11:39:18 +02:00
2024-05-01 05:07:06 +02:00
```
sudo dnf install git make gcc libcurl nodejs python libcurl4 g++
```
</details>
<details>
<summary>For Debian/Ubuntu</summary>
<br/>
2023-08-04 23:28:25 +02:00
```
2024-05-01 05:07:06 +02:00
sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++
```
2023-08-04 23:28:25 +02:00
2024-05-01 05:07:06 +02:00
</details>
<br/>
Once you have everything, clone our repo:
<details open>
<summary>Clone via Codeberg</summary>
<br/>
2023-08-04 23:28:25 +02:00
```
2024-05-01 05:07:06 +02:00
git clone https://codeberg.org/ashley/poke.git
```
2024-05-01 05:07:06 +02:00
</details>
<details>
<summary>Clone via GitHub</summary>
<br/>
2023-08-04 23:28:25 +02:00
2023-11-30 12:05:12 +01:00
```
2024-05-01 05:07:06 +02:00
git clone https://github.com/ashley0143/poke.git
2023-11-30 12:05:12 +01:00
```
2024-05-01 05:07:06 +02:00
</details>
<br/>
2023-11-30 12:05:12 +01:00
Now, install the needed dependencies within the Poke folder:
2024-02-16 18:00:55 +01:00
( go to the folder by running cd poke)
```
2022-08-06 16:11:23 +02:00
npm install
```
2023-08-04 23:28:25 +02:00
Once everythings installed, start your server with the following command:
2023-08-04 23:28:25 +02:00
```
node server.js
```
2023-03-05 06:48:43 +01:00
2023-11-07 06:12:41 +01:00
Congrats, Poketube should now be running on `localhost:6003`!
2022-07-19 21:59:19 +02:00
### With Docker
Create a new directory for PokeTube:
```
mkdir poketube && cd poketube
```
Download the docker compose and config file:
```
curl -O https://codeberg.org/Ashley/poke/raw/branch/main/docker-compose.yml
```
Run PokeTube:
```
docker compose up -d
```
PokeTube should be running on `http://localhost:6003`.
The port can be changed with the config file you downloaded, just change the `server_port` option.
2023-12-10 11:39:58 +01:00
## Hosting Image Proxy
see [here](https://codeberg.org/Ashley/poke/src/branch/main/january) :3
just uhh change the url in config.json to ur image proxy
2023-12-30 20:04:33 +01:00
## Poke community!
2023-12-30 20:04:33 +01:00
Join the community on [revolt](https://rvlt.gg/poketube) or [matrix](https://matrix.to/#/#poke:vern.cc) :3
## The Legal Stuff (boring tbh)
2023-12-30 20:04:33 +01:00
the main parts of the project is Under GPL-3.0-OR-LATER :3
see the each sections LICENSE tho!!
Copyleft 2021-202x Poke Project
[Code Of conduct](https://codeberg.org/Ashley/poke/src/branch/main/CODE_OF_CONDUCT.md)
2023-03-07 20:57:11 +01:00
2023-08-04 23:28:25 +02:00
[Privacy Policy](https://poketube.fun/privacy)
2022-08-25 13:40:24 +02:00
2023-08-04 23:28:25 +02:00
TL;DR: we dont collect or share your personal info, that's it lol.
2023-08-04 23:28:25 +02:00
We additionally use the GNU Coding Standard, see [this link.](https://www.gnu.org/prep/standards)
2023-10-07 11:35:32 +02:00
2023-10-07 11:55:21 +02:00
<div>
2023-10-17 17:33:09 +02:00
<h3>some parts of poketube.fun is proudly hosted on glitch.com since <i>2020</i> </h3>
<a href="https://glitch.com/"><img src="https://cdn.glitch.global/d68d17bb-f2c0-4bc3-993f-50902734f652/glitch-fastly-lock-up.svg?v=1696671148266"></a><br><hr>
<a href="https://gnu.org/not-open-source"><img width="200" src="https://autumn.revolt.chat/attachments/eNpfwV2C1_wudONe43YCvWr-4vbvLpG78HbuXgOYfO"></a>
2023-10-07 11:55:21 +02:00
</div>
2023-10-17 17:33:09 +02:00