Skip to content

Latest commit

 

History

History
177 lines (122 loc) · 7.69 KB

README.md

File metadata and controls

177 lines (122 loc) · 7.69 KB
Raw

Contributors Forks Stargazers Issues Docker Pulls AGPLv3 License


Intellectual

Alternate frontend for Genius focused on privacy and simplicity

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Instances
  3. Deployment
  4. Roadmap
  5. License

About The Project

Intellectual is an alternative frontend for Genius focused on privacy and simplicity.
Written in Rust, Intellectual is incredibly lightweight. Not requiring JavaScript and proxying all requests through the server, including images.

Intellectual is still very early in development and is lacking many features.
Check out the roadmap for what features will be coming next!

Instances

Want your own instance listed here? Open an issue for it!
Not sure how to host your own instance? View the deployment instructions.

URL Tor I2P Country Cloudflare
https://intellectual.insprill.net/ No No 🇺🇸 US ✔️
https://intellectual.catsarch.com/ Yes Yes 🇺🇸 US
https://intellectual.frontendfriendly.xyz/ No No 🇺🇸 US
https://intellectual.lumaeris.com/ No No 🇺🇸 US
https://in.bloat.cat/ No No 🇷🇴 RO
https://in2.bloat.cat/ No No 🇩🇪 DE
https://intellectual.ducks.party/ Yes No 🇩🇪 DE
https://intellectual.bunk.lol/ No No 🇮🇸 IS

If there is a checkmark under "Cloudflare", that means the site is proxied behind Cloudflare.
This means they have the ability to monitor traffic between you and the server.

The instances list in JSON format can be found in the instances.json file.

Deployment

Deploying

Docker

The easiest way to host intellectual is via Docker, and the included Docker Compose file. To create a new directory, download the docker-compose.yml, and cd into the directory, run the following command (Requires cURL 7.10.3 or newer)

curl https://raw.githubusercontent.com/Insprill/intellectual/master/docker-compose.yml --create-dirs -o intellectual/docker-compose.yml && cd intellectual

By default, it'll bind to 127.0.0.1:8080. Once you're satisfied with the container, you can start it with

docker compose up -d

Native

If you don't want to use Docker, you can download the latest stable or nightly build from GitHub actions. Make sure to choose the version for your target operating system.

Append the -h flag when running to see all available arguments.

TLS

Intellectual supports TLS connections natively using rustls. To enable TLS, provide the --tls flag, followed by --tls-key-file and --tls-cert-file pointing to their respective files on disk.

Roadmap

  • Search for songs
  • View lyrics
  • More song info on the lryics page
    • Song name
    • Song/album image
    • Album name
    • Artist
    • Release date
  • View artist info
  • Paginated searches
  • More robust error handling
  • Show artists' work on their page
  • Improve responsiveness
  • View Albums
  • Theme support
  • Annotation support
  • More search types
    • By lyrics
    • For artists
    • For albums
  • Better accessibility
  • Support for more lyric sources

Contributions are what make the open-source community such an amazing place to learn, inspire, and create.
Any contributions you make are greatly appreciated!
If you're new to contributing to open-source projects, you can follow this guide to get up-to-speed.

License

Distributed under the GNU Affero General Public License v3.0.
See LICENSE for more information.