Skip to content

Latest commit

 

History

History
91 lines (77 loc) · 4.74 KB

README.md

File metadata and controls

91 lines (77 loc) · 4.74 KB
Raw

GLOBE

Project "GLOBE", the Global Liberation Of Browsing and Entertainment, is an effort to improve the access to privacy-friendly frontends (namely Invidious, RedLib, SearXNG, and BreezeWiki) across the globe. The results of this effort can be seen on the official hosting list.

This git repo serves as the internal structure and setup used in the official servers. It's designed to be easily integrated into any server, while still allowing modifications for any changes necessary.

To start, simply run scripts/init.sh:

git clone --recurse-submodules https://github.com/ggtylerr/globe
cd globe
chmod +x scripts/init.sh
./scripts/init.sh

For the best results, use a debian-based distro, like Ubuntu.

Frontends

Below is a list of frontends hosted, as well as any notes about their setup.

  • Invidious (port: 54301)
    • Configured to use the latest patch, utilizing poToken and visitorData. Because of this, it is required to generate one before running Invidious. (One is generated for you when using init.sh.)
    • Configured to use unixfox's performant configuration (with the exception of http3-ytproxy, which is deprecated software and does not work) and pgbouncer.
  • Piped (port: 54302)
    • This software is not expected to work on public instances yet.
  • Hyperpipe (ports: 54303, 54304)
    • This relies on the above Piped instance.
  • Poke (port: 54305)
    • Due to issues relating to their Docker image, this service runs on bare metal.
  • RedLib (port: 54306)
  • SafeTwitch (ports: 54307, 54308)
  • Dumb (port: 54309)
  • Breezewiki (port: 54310)
  • Cobalt (ports: 54311, 54312)
  • SearXNG (port: 54313)
  • LibreY (port: 54314)
  • SimpleTranslate (port: 54315)
  • LibreTranslate (port: 54316)
  • Lingva (port: 54317)
  • Mozhi (port: 54318)

Additional Notes

While Project GLOBE is mostly complete, it was primarily designed around using a specific setup (Ubuntu, Nginx, Docker, etc.) We currently do not have the means to support other configurations (such as a fully bare metal host, or using Caddy.)

By default, init.sh sets up all instances. However, you can use flags to set up only a selection of instances:

init.sh -irscx

These flags will be changed in the near future, but for the time being, they are:

Flag Frontend
-i Invidious
-p Piped
-h Hyperpipe
-k Poke
-r RedLib
-s SafeTwitch
-d Dumb
-b Breezewiki
-c Cobalt
-x SearXNG
-y LibreY
-t SimplyTranslate
-l LibreTranslate
-v Lingva
-m Mozhi

It should also be noted that due to the constantly changing nature of these services and the websites they proxy, they are not expected to last forever and updates should be done whenever possible. Most docker containers should be updated automatically via Watchtower (with the exception of SimplyTranslate, which has no hosted image and is built manually,) however, any config changes can be done over update.sh.

Since Poke is running over bare metal, it can be updated using the following:

cd services/poke
git pull
# Resolve any changes needed, since config.json is modified and it may be updated in the future
pm2 restart poke

License

This project is licensed under AGPL v3. Several other repositories are used in this project and their license/s are followed as best as possible. For any legal inquiries, please contact the main author of this project, Tyler Flowers "ggtyler"