13 |
14 |
24 |
25 |
26 |
27 |
28 |
29 | Intellectual
15 |
16 | Alternate frontend for Genius focused on privacy and simplicity
17 |
18 |
19 | Report Bug
20 | ·
21 | Request Feature
22 |
30 |
39 |
40 |
41 |
42 |
43 |
44 |
45 | ## About The Project
46 |
47 | Intellectual is an alternative frontend for [Genius](https://genius.com/) focused on privacy and simplicity.
48 | Written in Rust, Intellectual is incredibly lightweight.
49 | Not requiring JavaScript and proxying all requests through the server, including images.
50 |
51 | Intellectual is still very early in development and is lacking many features.
52 | Check out the [roadmap](#roadmap) for what features will be coming next!
53 |
54 |
55 |
56 |
57 |
58 |
59 | ## Instances
60 |
61 | Want your own instance listed here? Open an issue for it!
62 | Not sure how to host your own instance? View the [deployment](#deployment) instructions.
63 |
64 | | URL | Tor | I2P | Country | Cloudflare |
65 | |--------------------------------------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|-----------|------------|
66 | | https://intellectual.insprill.net/ | No | No | 🇺🇸 US | ✔️ |
67 | | https://intellectual.catsarch.com/ | [Yes](http://intellectual.catsarchywsyuss6jdxlypsw5dc7owd5u5tr6bujxb7o6xw2hipqehyd.onion) | [Yes](http://ahysxi4w2wl7vf7ghy3hbqibvdg4e7je3s2lrsrb6xpukklevrka.b32.i2p) | 🇺🇸 US | |
68 | | https://intellectual.frontendfriendly.xyz/ | No | No | 🇺🇸 US | |
69 | | https://intellectual.lumaeris.com/ | No | No | 🇺🇸 US | |
70 | | https://in.bloat.cat/ | No | No | 🇷🇴 RO | |
71 | | https://in2.bloat.cat/ | No | No | 🇩🇪 DE | |
72 | | https://intellectual.ducks.party/ | [Yes](http://pgsivdkc7p5qyxp7leorxk32mkomepxsmrqhpzqqi2zf2nc6urzodfad.onion) | No | 🇩🇪 DE | |
73 | | https://intellectual.bunk.lol/ | No | No | 🇮🇸 IS | |
74 | | https://genius.blitzw.in/ | No | No | 🇩🇰 DK | |
75 |
76 | If there is a checkmark under "Cloudflare", that means the site
77 | is proxied behind [Cloudflare](https://www.cloudflare.com/).
78 | This means they have the ability to monitor traffic between you and the server.
79 |
80 | The instances list in JSON format can be found in the [instances.json](instances.json) file.
81 |
82 |
83 |
84 |
85 |
86 |
87 | ## Deployment
88 |
89 | ### Deploying
90 |
91 | #### Docker
92 |
93 | The easiest way to host intellectual is via Docker, and the included Docker Compose file.
94 | 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)
95 | ```bash
96 | curl https://raw.githubusercontent.com/Insprill/intellectual/master/docker-compose.yml --create-dirs -o intellectual/docker-compose.yml && cd intellectual
97 | ```
98 | By default, it'll bind to `127.0.0.1:8080`.
99 | Once you're satisfied with the container, you can start it with
100 | ```bash
101 | docker compose up -d
102 | ```
103 |
104 | #### Native
105 |
106 | If you don't want to use Docker, you can download the latest [stable](https://github.com/Insprill/intellectual/releases) or [nightly](https://nightly.link/Insprill/intellectual/workflows/rust/master) build from GitHub actions. Make sure to choose the version for your target operating system.
107 |
108 | Append the `-h` flag when running to see all available arguments.
109 |
110 | ### TLS
111 |
112 | Intellectual supports TLS connections natively using [rustls][rustls-repo].
113 | To enable TLS, provide the `--tls` flag, followed by `--tls-key-file` and `--tls-cert-file` pointing to their respective files on disk.
114 |
115 |
116 |
117 |
118 |
119 |
120 | ## Roadmap
121 |
122 | - [x] Search for songs
123 | - [x] View lyrics
124 | - [x] More song info on the lryics page
125 | - Song name
126 | - Song/album image
127 | - Album name
128 | - Artist
129 | - Release date
130 | - [x] View artist info
131 | - [x] Paginated searches
132 | - [x] More robust error handling
133 | - [x] Show artists' work on their page
134 | - [x] Improve responsiveness
135 | - [x] View Albums
136 | - [x] Theme support
137 | - [ ] Annotation support
138 | - [ ] More search types
139 | - By lyrics
140 | - For artists
141 | - For albums
142 | - [ ] Better accessibility
143 | - [ ] Support for more lyric sources
144 |
145 | Contributions are what make the open-source community such an amazing place to learn, inspire, and create.
146 | Any contributions you make are **greatly appreciated**!
147 | If you're new to contributing to open-source projects,
148 | you can follow [this](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) guide to get up-to-speed.
149 |
150 |
151 |
152 |
153 |
154 |
155 | ## License
156 |
157 | Distributed under the GNU Affero General Public License v3.0.
158 | See [LICENSE][license-url] for more information.
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 | [contributors-shield]: https://img.shields.io/github/contributors/Insprill/intellectual.svg?style=for-the-badge
167 | [contributors-url]: https://github.com/Insprill/intellectual/graphs/contributors
168 | [forks-shield]: https://img.shields.io/github/forks/Insprill/intellectual.svg?style=for-the-badge
169 | [forks-url]: https://github.com/Insprill/intellectual/network/members
170 | [stars-shield]: https://img.shields.io/github/stars/Insprill/intellectual.svg?style=for-the-badge
171 | [stars-url]: https://github.com/Insprill/intellectual/stargazers
172 | [issues-shield]: https://img.shields.io/github/issues/Insprill/intellectual.svg?style=for-the-badge
173 | [issues-url]: https://github.com/Insprill/intellectual/issues
174 | [license-shield]: https://img.shields.io/github/license/Insprill/intellectual.svg?style=for-the-badge
175 | [license-url]: https://github.com/Insprill/intellectual/blob/master/LICENSE
176 | [docker-pulls-shield]: https://img.shields.io/docker/pulls/insprill/intellectual?style=for-the-badge
177 | [docker-pulls-url]: https://hub.docker.com/r/insprill/intellectual
178 | [rustls-repo]: https://github.com/rustls/rustls
179 |
--------------------------------------------------------------------------------
/build.rs:
--------------------------------------------------------------------------------
1 | use random_string::charsets::ALPHANUMERIC;
2 | use random_string::generate;
3 | use std::env;
4 | use std::process::Command;
5 |
6 | fn main() {
7 | set_version();
8 | set_repo_url();
9 | }
10 |
11 | fn set_repo_url() {
12 | let cargo_repo_url = env!("CARGO_PKG_REPOSITORY");
13 | let mut repo_url = cargo_repo_url.to_string();
14 |
15 | if is_git_repo() {
16 | repo_url = get_remote_url();
17 | if repo_url.starts_with("https://github.com/") {
18 | // The URL might already end with a '/', but GitHub seems to handle it fine if there's two.
19 | // Tested in both Firefox and Chromium.
20 | repo_url.push_str(&format!(
21 | "/tree/{}",
22 | if is_git_tagged() {
23 | get_git_tag()
24 | } else {
25 | get_git_hash()
26 | }
27 | ));
28 | }
29 | } else {
30 | println!("Not a Git repo! Skipping repo URL metadata");
31 | }
32 |
33 | println!("cargo:rustc-env=IN_REPO_URL={}", repo_url);
34 | }
35 |
36 | fn set_version() {
37 | let cargo_version = env!("CARGO_PKG_VERSION");
38 | let mut version = cargo_version.to_string();
39 |
40 | if is_git_repo() {
41 | let is_repo_dirty = is_repo_dirty();
42 | if !is_git_tagged() || is_repo_dirty {
43 | version.push_str("+rev.");
44 | version.push_str(&get_git_hash());
45 |
46 | // Add some randomness if dirty to avoid the browser caching resources while iterating.
47 | if is_repo_dirty {
48 | version.push_str("-dirty-");
49 | version.push_str(&generate(4, ALPHANUMERIC));
50 | }
51 | }
52 | } else {
53 | println!("Not a Git repo! Skipping version metadata");
54 | }
55 |
56 | println!("cargo:rustc-env=IN_VERSION={}", version);
57 | }
58 |
59 | fn is_git_repo() -> bool {
60 | if let Ok(var) = env::var("IN_IS_GIT") {
61 | return var == "true";
62 | }
63 | Command::new("git").args(["status"]).status().is_ok()
64 | }
65 |
66 | fn get_git_hash() -> String {
67 | if let Ok(var) = env::var("IN_GIT_HASH") {
68 | return var;
69 | }
70 |
71 | let output = Command::new("git")
72 | .args(["rev-parse", "--short", "HEAD"])
73 | .output()
74 | .expect("Failed to execute git command");
75 |
76 | String::from_utf8_lossy(&output.stdout).trim().to_string()
77 | }
78 |
79 | fn is_repo_dirty() -> bool {
80 | if let Ok(var) = env::var("IN_GIT_DIRTY") {
81 | return var == "true";
82 | }
83 |
84 | let status_output = Command::new("git")
85 | .args(["status", "--porcelain"])
86 | .output()
87 | .expect("Failed to execute git status command");
88 |
89 | !status_output.stdout.is_empty()
90 | }
91 |
92 | fn is_git_tagged() -> bool {
93 | if let Ok(var) = env::var("IN_GIT_TAGGED") {
94 | return var == "true";
95 | }
96 |
97 | get_git_tag_info().0
98 | }
99 |
100 | fn get_git_tag() -> String {
101 | if let Ok(var) = env::var("IN_GIT_TAG") {
102 | return var;
103 | }
104 |
105 | get_git_tag_info().1
106 | }
107 |
108 | fn get_git_tag_info() -> (bool, String) {
109 | let output = Command::new("git")
110 | .args(["describe", "--tags", "--exact-match"])
111 | .output()
112 | .expect("Failed to execute git describe command");
113 |
114 | let is_tagged = output.status.success();
115 | let tag = String::from_utf8_lossy(&output.stdout).trim().to_string();
116 |
117 | (is_tagged, tag)
118 | }
119 |
120 | fn get_remote_url() -> String {
121 | if let Ok(var) = env::var("IN_GIT_REMOTE_URL") {
122 | return var;
123 | }
124 |
125 | let remote_url = Command::new("git")
126 | .args(["remote", "get-url", "origin"])
127 | .output()
128 | .expect("Failed to execute git command");
129 |
130 | String::from_utf8_lossy(&remote_url.stdout)
131 | .trim()
132 | .to_string()
133 | }
134 |
--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
1 | services:
2 | intellectual:
3 | image: insprill/intellectual:latest # Switch to 'develop' to use the latest git version. May be unstable!
4 | restart: always
5 | ports:
6 | - 8080:8080 # Use `127.0.0.1:8080:8080` if you're using a reverse proxy on the same machine.
7 | read_only: true
8 | security_opt:
9 | - no-new-privileges:true
10 | cap_drop:
11 | - ALL
12 | healthcheck:
13 | test: wget -nv --tries=1 --spider http://127.0.0.1:8080 || exit 1
14 | interval: 1m
15 | timeout: 5s
16 |
--------------------------------------------------------------------------------
/instances.json:
--------------------------------------------------------------------------------
1 | [
2 | {
3 | "clearnet": "https://intellectual.insprill.net/",
4 | "country": "US",
5 | "cdn": true
6 | },
7 | {
8 | "clearnet": "https://intellectual.catsarch.com/",
9 | "tor": "http://intellectual.catsarchywsyuss6jdxlypsw5dc7owd5u5tr6bujxb7o6xw2hipqehyd.onion/",
10 | "i2p": "http://ahysxi4w2wl7vf7ghy3hbqibvdg4e7je3s2lrsrb6xpukklevrka.b32.i2p",
11 | "country": "US",
12 | "cdn": false
13 | },
14 | {
15 | "clearnet": "https://intellectual.frontendfriendly.xyz/",
16 | "country": "US",
17 | "cdn": false
18 | },
19 | {
20 | "clearnet": "https://intellectual.lumaeris.com/",
21 | "country": "US",
22 | "cdn": false
23 | },
24 | {
25 | "clearnet": "https://in.bloat.cat/",
26 | "country": "RO",
27 | "cdn": false
28 | },
29 | {
30 | "clearnet": "https://in2.bloat.cat/",
31 | "country": "DE",
32 | "cdn": false
33 | },
34 | {
35 | "clearnet": "https://intellectual.ducks.party/",
36 | "tor": "http://pgsivdkc7p5qyxp7leorxk32mkomepxsmrqhpzqqi2zf2nc6urzodfad.onion/",
37 | "country": "DE",
38 | "cdn": false
39 | },
40 | {
41 | "clearnet": "https://intellectual.bunk.lol/",
42 | "country": "IS",
43 | "cdn": false
44 | },
45 | {
46 | "clearnet": "https://genius.blitzw.in/",
47 | "country": "DK",
48 | "cdn": false
49 | }
50 | ]
51 |
--------------------------------------------------------------------------------
/src/album.rs:
--------------------------------------------------------------------------------
1 | use crate::genius::{self, GeniusAlbumResponse};
2 | use crate::settings::{settings_from_req, Settings};
3 | use crate::utils;
4 | use actix_web::HttpRequest;
5 | use actix_web::{get, Responder, Result};
6 | use askama::Template;
7 |
8 | use crate::genius::GeniusAlbum;
9 | use crate::templates::template;
10 |
11 | #[derive(Template)]
12 | #[template(path = "album.html")]
13 | struct AlbumTemplate {
14 | settings: Settings,
15 | album: GeniusAlbum,
16 | }
17 |
18 | #[get("/albums/{name:.*}")]
19 | pub async fn album(req: HttpRequest) -> ResultTable of Contents
31 |-
32 |
- About The Project 33 |
- Instances 34 |
- Deployment 35 |
- Roadmap 36 |
- License 37 |
9 |
14 |
16 | {% endblock %}
17 |
--------------------------------------------------------------------------------
/templates/404.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}Page Not Found - {% endblock %}
4 |
5 | {% block style %}/style/error.css{% endblock %}
6 |
7 | {% block content %}
8 | Bad Request
10 | {% if err.is_some() %} 11 |{{ err.as_ref().unwrap() }}
12 | {% endif %} 13 |14 |
If this continues to occur, please report it.
15 |
9 |
12 | {% endblock %}
13 |
--------------------------------------------------------------------------------
/templates/500.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}Internal Error - {% endblock %}
4 |
5 | {% block style %}/style/error.css{% endblock %}
6 |
7 | {% block content %}
8 | Page Not Found
10 |The page you requested couldn't be found!
11 |
9 |
14 |
16 | {% endblock %}
17 |
--------------------------------------------------------------------------------
/templates/album.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{album.name}} - {% endblock %}
4 |
5 | {% block style %}/style/lyrics.css{% endblock %}
6 | {% block head %}
7 |
8 | {% endblock %}
9 |
10 | {% block navright %}
11 |
14 | {% endblock %}
15 |
16 | {% block content %}
17 | Internal Error
10 | {% if err.is_some() %} 11 |{{ err.as_ref().unwrap() }}
12 | {% endif %} 13 |14 |
If this continues to occur, please report it.
15 |
18 |
35 | {% if album.tracks.is_some() %} 36 |
44 | {% endblock %}
45 |
--------------------------------------------------------------------------------
/templates/artist.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{artist.name}} - {% endblock %}
4 |
5 | {% block style %}/style/artist.css{% endblock %}
6 | {% block head %}
7 |
8 | {% endblock %}
9 |
10 |
11 | {% block navright %}
12 |
15 | {% endblock %}
16 |
17 | {% block content %}
18 |
19 | 
33 |
34 |
20 |
27 | {{ album.name|e }}
21 |By 22 | 23 | {{ album.artist.name|e }} 24 | 25 |
26 |
28 | {% if album.release_date_for_display.is_some() %}
29 |
32 | Released on {{ album.release_date_for_display.as_ref().unwrap()|e }}
30 | {% endif %} 31 |35 | {% if album.tracks.is_some() %} 36 |
37 |
42 | {% endif %}
43 | Tracks
38 | {% for song in album.tracks.as_ref().unwrap() %} 39 | {% include "song.html" %} 40 | {% endfor %} 41 |
19 | 
20 |
53 | {% endblock %}
54 |
--------------------------------------------------------------------------------
/templates/base.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
21 |
31 | {{ artist.name|e }}
22 | {% if artist.alternate_names.is_some() && !artist.alternate_names.as_ref().unwrap().is_empty() %} 23 |24 | AKA: 25 | {% for nickname in artist.alternate_names.as_ref().unwrap() %} 26 | {{ nickname|e }}{% if !loop.last %},{% endif %} 27 | {% endfor %} 28 |
29 | {% endif %} 30 |
32 | {% for social in artist.socials() %}
33 |
34 | 
35 |
36 |
37 | {% endfor %}
38 |
39 | {% if artist.description.is_some() %}
40 |
35 |
36 |
37 | {% endfor %}
38 | {{ artist.description.as_ref().unwrap().html|safe|paragraphbreaks|safe }}
41 | {% endif %}
42 |
43 | {% if artist.popular_songs.is_some() %}
44 |
45 |
51 | {% endif %}
52 | Popular Songs
46 | {% for song in artist.popular_songs.as_ref().unwrap() %} 47 | {% include "song.html" %} 48 | {% endfor %} 49 | Search for songs 50 |
15 |
23 |
24 | {% endblock %}
25 |
--------------------------------------------------------------------------------
/templates/lyrics.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}{{song.title}} - {% endblock %}
4 |
5 | {% block style %}/style/lyrics.css{% endblock %}
6 |
7 | {% block navright %}
8 |
11 | {% endblock %}
12 |
13 | {% block content %}
14 |
15 |
42 | {% for verse in verses %} 43 |
49 | {% endif %} 50 | {% endfor %} 51 |
52 | {% endblock %}
53 |
--------------------------------------------------------------------------------
/templates/search.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}Search - {% endblock %}
4 |
5 | {% block style %}/style/search.css{% endblock %}
6 | {% block head %}
7 |
8 | {% endblock %}
9 |
10 | {% block navright %}
11 | Search on Genius
12 | {% endblock %}
13 |
14 | {% block content %}
15 |
16 | 
40 |
41 |
17 |
31 | {{ song.title|e }}
18 |By 19 | 20 | {{ song.primary_artist.name|e }} 21 | 22 |
23 | {% if song.album.is_some() %} 24 |On 25 | 26 | {{ song.album.as_ref().unwrap().name|e }} 27 | 28 |
29 | {% endif %} 30 |
32 | {% if song.release_date_for_display.is_some() %}
33 |
39 | Released on {{ song.release_date_for_display.as_ref().unwrap()|e }}
34 | {% endif %} 35 | {% if song.stats.pageviews.is_some() %} 36 |{{ utils::pretty_format_num(song.stats.pageviews.unwrap())|e }} Views
37 | {% endif %} 38 |42 | {% for verse in verses %} 43 |
{{ verse.title|e }}
44 | {% for lyric in verse.lyrics %} 45 |{{ lyric|e }}
46 | {% endfor %} 47 | {% if !loop.last %} 48 |49 | {% endif %} 50 | {% endfor %} 51 |
16 | {% for song in songs %}
17 | {% include "song.html" %}
18 | {% endfor %}
19 |
37 | {% endblock %}
38 |
--------------------------------------------------------------------------------
/templates/settings.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block title %}Settings - {% endblock %}
4 |
5 | {% block style %}/style/settings.css{% endblock %}
6 |
7 | {% block content %}
8 |
20 | {% if current_page > 1 %}
21 |
22 | Prev
23 |
24 | {% endif %}
25 | {% for n in nav_pages %}
26 |
27 | {{n}}
28 |
29 | {% endfor %}
30 | {% if current_page < 100 %}
31 |
32 | Next
33 |
34 | {% endif %}
35 |
36 |
9 |
20 |
21 | {% endblock %}
22 |
--------------------------------------------------------------------------------
/templates/song.html:
--------------------------------------------------------------------------------
1 |
2 |