mirror of
https://codeberg.org/ashley/poke.git
synced 2024-11-22 11:37:49 +01:00
Update README.md
This commit is contained in:
ashley
parent
052547350a
commit
b9fe538feb
1 changed files with 64 additions and 149 deletions
213
README.md
213
README.md
|
|
@ -1,176 +1,87 @@
|
|||
|
||||
<h1 align="center">
|
||||
<a href="https://poketube.fun/watch?v=9sJUDx7iEJw&quality=medium&=sjohgteojgytrueugtye4jhtytjrjnyıı">
|
||||
<img src="https://poketube.fun/css/logo-poke.svg" width="400">
|
||||
<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>
|
||||
</a>
|
||||
<p>The Ultimate Privacy App</p>
|
||||
</h1>
|
||||
|
||||
<div align="center">
|
||||
|
||||
<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>
|
||||
|
||||
<img src="https://poketube.fun/css/logo-poke.svg" width="400">
|
||||
</a>
|
||||
<a href="http://www.defectivebydesign.org/drm-free">
|
||||
<img src="https://static.fsf.org/dbd/label/DRM-free%20label%20120.en.png"
|
||||
alt="DRM Free" width="65" height="65" border="0" align="middle" />
|
||||
</a>
|
||||
<p>PRIVACY APP OF YOUR DREAMS! :3</p>
|
||||
</h1>
|
||||
|
||||
<div align="center">
|
||||
<p>Be anonymous while watching (cat falling) videos, searching the web, and listening to music on Poke - the free privacy front-end!</p>
|
||||
</div>
|
||||
|
||||
[Welcome!](#welcome) | [Features](#features) | [No non-free codec needed](#no-non-free-codec-needed-3) | [Hosting Poke~](#hosting-poketube) | [Poke community!](#poketube-community) | [The Legal Stuff (boring tbh)](#the-legal-stuff-boring-tbh)
|
||||
|
||||
<a href="https://status.poketube.fun" target="_blank">
|
||||
<img
|
||||
width="170"
|
||||
src="https://api.netweak.com/status-badges/K2LY9"
|
||||
alt="Netweak status badge"
|
||||
/>
|
||||
</a><br>
|
||||
<a href="https://tosdr.org/en/service/7114">
|
||||
<img src="https://shields.tosdr.org/en_7114.svg"/>
|
||||
</a>
|
||||
<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>
|
||||
<div align="center">
|
||||
<a href="#welcome">Welcome!</a> | <a href="#features">Features</a> | <a href="#no-non-free-codec-needed">No Non-Free Codec</a> | <a href="#hosting-poke">Hosting</a> | <a href="#poke-community">Community</a> | <a href="#legal">Legal</a>
|
||||
<br><br>
|
||||
<a href="https://status.poketube.fun" target="_blank">
|
||||
<img width="170" src="https://api.netweak.com/status-badges/K2LY9" alt="Status Badge"/>
|
||||
</a>
|
||||
<img src="https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg" alt="Stand with Ukraine">
|
||||
<a href="./LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-GPL--3-FF6666" alt="GPL-3 License">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
## Welcome!
|
||||
|
||||
This is the source code of Poke (formerly PokeTube), the privacy-friendly youtube front-end built with the InnerTube API!
|
||||
Welcome to Poke (formerly PokeTube), the privacy-friendly YouTube front-end built with the InnerTube API! Imagine paying for YouTube Premium just to download videos - couldn't be us (literally).
|
||||
|
||||
# Features
|
||||
## Features
|
||||
|
||||
| <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> |
|
||||
| <img width="100%" style="border-radius: 24px" src="./css/README_RYD.png"> | <div style="text-align: left"><h3>🔙 Built-In Return YouTube Dislikes</h3>See the dislikes from *returnyoutubedislike* - because sometimes you need to know how bad that video really is :3</div> |
|
||||
| - | - |
|
||||
| <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"> |
|
||||
| <div style="text-align: right"><h3>📱 PWA Support</h3>With PWA Support, you can install Poke on your mobile device. Now you can pretend to be productive while watching cat videos on the go, mreoww! :3</div> | <img width="100%" style="border-radius: 24px" src="./css/README_PWA.jpg"> |
|
||||
| <h3>🎨 Customize</h3>Customize Poke however you want. Make it as unique as your taste in memes. | <h3>📥 Accounts</h3>Suscribe (yes Suscribe hehe sussy baka) to whaever channel you want! </div> |
|
||||
| <h3>🔍 Web Search</h3>Search the web privately on PokeTube. Incognito mode who? | <h3>🎶 And...</h3>Ambient mode, HQ audio, and even more! :3 |
|
||||
|
||||
<h3>Customize</h3>
|
||||
Customize Poketube However you want :3
|
||||
## No Non-Free Codec Needed
|
||||
|
||||
<h3>Accounts </h3>
|
||||
Suscribe (yes Suscribe hehe sussy baka) to whaever channel you want!
|
||||
Poke uses OpenH264, which is free software! No non-free components included :3 View the source code of OpenH264 [here](https://github.com/cisco/openh264.git). Because who wants to deal with non-free stuff? Not us!~
|
||||
|
||||
<h3>Web Search </h3>
|
||||
Search the web privatly on poketube :3
|
||||
## Hosting Poke
|
||||
|
||||
<br>
|
||||
<h3>And... </h3>
|
||||
<p>
|
||||
Ambient mode, HQ audio And Even more!!!!!
|
||||
</p>
|
||||
### NodeJS
|
||||
|
||||
## Written by humans - not gpt
|
||||
poke is made by hard-working hoomans - not gpt :3<br>
|
||||
<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>
|
||||
1. **Install Packages**
|
||||
- Fedora/RHEL: `$ sudo dnf install git make gcc libcurl nodejs python libcurl4 g++`
|
||||
- Debian/Ubuntu: `$ sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++`
|
||||
|
||||
## No Non-free codec needed :3
|
||||
2. **Clone Repo**
|
||||
- Codeberg: `$ git clone https://codeberg.org/ashley/poke.git`
|
||||
- GitHub: `$ git clone https://github.com/ashley0143/poke.git`
|
||||
|
||||
Poke uses openh264 which is free software! poketube does not inculude non free stuff owowowoow!!!!
|
||||
3. **Install Dependencies**
|
||||
- `$ cd poke`
|
||||
- `$ npm install`
|
||||
|
||||
you can view the source code of the openh264 codec in this repo :3 --> https://github.com/cisco/openh264.git
|
||||
4. **Start Server**
|
||||
- `$ node server.js`
|
||||
|
||||
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.
|
||||
Congrats! PokeTube should now be running on `localhost:6003`! 🎉
|
||||
|
||||
## Hosting Poke~
|
||||
### Docker
|
||||
|
||||
### 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
|
||||
1. **Create Directory**
|
||||
- `$ mkdir poketube && cd poketube`
|
||||
|
||||
### With NodeJS
|
||||
To self host your own Poke instance, you'll need some packages installed on your GNU/Linux install.
|
||||
2. **Download Config**
|
||||
- `$ curl -O https://codeberg.org/Ashley/poke/raw/branch/main/docker-compose.yml`
|
||||
|
||||
<details>
|
||||
<summary>For Fedora/RHEL/Rocky/CentOS</summary>
|
||||
<br/>
|
||||
3. **Run PokeTube**
|
||||
- `$ docker compose up -d`
|
||||
|
||||
```
|
||||
sudo dnf install git make gcc libcurl nodejs python libcurl4 g++
|
||||
```
|
||||
Congrats! PokeTube should now be running on `localhost:6003`! 🎉
|
||||
|
||||
</details>
|
||||
## Poke Community
|
||||
|
||||
<details>
|
||||
<summary>For Debian/Ubuntu</summary>
|
||||
<br/>
|
||||
Join us on [Revolt](https://rvlt.gg/poketube) or [Matrix](https://matrix.to/#/#poke:vern.cc)! I promise we're cool! <3
|
||||
|
||||
```
|
||||
sudo apt install git make gcc libcurl4-openssl-dev nodejs npm python g++
|
||||
```
|
||||
|
||||
</details>
|
||||
<br/>
|
||||
|
||||
Once you have everything, clone our repo:
|
||||
|
||||
<details open>
|
||||
<summary>Clone via Codeberg</summary>
|
||||
<br/>
|
||||
|
||||
```
|
||||
git clone https://codeberg.org/ashley/poke.git
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Clone via GitHub</summary>
|
||||
<br/>
|
||||
|
||||
```
|
||||
git clone https://github.com/ashley0143/poke.git
|
||||
```
|
||||
|
||||
</details>
|
||||
<br/>
|
||||
|
||||
Now, install the needed dependencies within the Poke folder:
|
||||
( go to the folder by running cd poke)
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
Once everythings installed, start your server with the following command:
|
||||
|
||||
```
|
||||
node server.js
|
||||
```
|
||||
|
||||
Congrats, Poketube should now be running on `localhost:6003`!
|
||||
|
||||
### 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.
|
||||
|
||||
## 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
|
||||
|
||||
## Poke community!
|
||||
|
||||
Join the community on [revolt](https://rvlt.gg/poketube) or [matrix](https://matrix.to/#/#poke:vern.cc) :3
|
||||
|
||||
|
||||
## The Legal Stuff (boring tbh)
|
||||
the main parts of the project is Under GPL-3.0-OR-LATER :3
|
||||
|
|
@ -178,18 +89,22 @@ 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)
|
||||
|
||||
[Privacy Policy](https://poketube.fun/privacy)
|
||||
|
||||
TL;DR: we dont collect or share your personal info, that's it lol.
|
||||
|
||||
We additionally use the GNU Coding Standard, see [this link.](https://www.gnu.org/prep/standards)
|
||||
We use the GNU Coding Standard Thingy, see [this link.](https://www.gnu.org/prep/standards)
|
||||
|
||||
<div>
|
||||
<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>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<p>Parts of Poke are hosted on Glitch.com since <i>2020</i>.</p>
|
||||
<a href="https://glitch.com/">
|
||||
<img src="https://cdn.glitch.global/d68d17bb-f2c0-4bc3-993f-50902734f652/glitch-fastly-lock-up.svg">
|
||||
</a>
|
||||
<br><hr>
|
||||
<a href="https://gnu.org/not-open-source">
|
||||
<img width="200" src="https://autumn.revolt.chat/attachments/eNpfwV2C1_wudONe43YCvWr-4vbvLpG78HbuXgOYfO">
|
||||
</a>
|
||||
</div>
|
||||
Loading…
Reference in a new issue