diff --git a/README.md b/README.md index c4030c7..406c7d5 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,82 @@ # [Bibliogram](https://bibliogram.art) -[![Humane Tech badge.](https://raw.githubusercontent.com/cloudrac3r/bibliogram/master/art/humane-tech-badge.svg?sanitize=true)](https://github.com/humanetech-community/awesome-humane-tech#readme) ![GitHub](https://img.shields.io/github/license/cloudrac3r/bibliogram) [![Discussion on Matrix.](https://img.shields.io/matrix/bibliogram:matrix.org?label=%23bibliogram&logo=matrix)](https://matrix.to/#/#bibliogram:matrix.org) +[![Humane Tech badge.](https://meta.bibliogram.art/art/humane-tech-badge.svg)](https://github.com/humanetech-community/awesome-humane-tech#readme) +![GitHub](https://img.shields.io/github/license/cloudrac3r/bibliogram) +[![Discussion on Matrix.](https://img.shields.io/matrix/bibliogram:matrix.org?label=%23bibliogram&logo=matrix)](https://matrix.to/#/#bibliogram:matrix.org) -## An alternative front-end for Instagram. +## Attention! The GitHub repository will be moving soon. -Bibliogram works without client-side JavaScript, has no ads or tracking, and doesn't urge you to sign up. +The new home is on sourcehut: https://sr.ht/~cadence/bibliogram/ -See Bibliogram's features: [Wiki:Features](https://github.com/cloudrac3r/bibliogram/wiki/Features) +The GitHub repository will remain here in some form, and may be kept up to date, but you should avoid using it. -Join the Bibliogram discussion room on Matrix: [#bibliogram:matrix.org](https://matrix.to/#/#bibliogram:matrix.org) +## Navigation -See also: [Invidious, a front-end for YouTube.](https://github.com/omarroth/invidious) +- [Bibliogram project on sourcehut][project] +- [Bibliogram code repository][main repo] +- [Bibliogram issues tracker][issues] +- [Updater code repository][updater repo] +- [Full documentation][docs folder] +- [Discussion on Matrix][matrix] + +[project]: https://sr.ht/~cadence/bibliogram/ +[main repo]: https://git.sr.ht/~cadence/bibliogram +[issues]: https://todo.sr.ht/~cadence/bibliogram-issues +[updater repo]: https://git.sr.ht/~cadence/bibliogram-updater +[docs folder]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs + +## Bibliogram is an alternative front-end for Instagram. + +Bibliogram works without browser JavaScript, has no ads or tracking, +and doesn't urge you to sign up. + +See Bibliogram's features: [`docs/Features.md`][features] + +[features]: https://git.sr.ht/~cadence/bibliogram-docs/tree/main/docs/Features.md + +Join the Bibliogram discussion room on Matrix: +[#bibliogram:matrix.org][matrix] + +[matrix]: https://matrix.to/#/#bibliogram:matrix.org + +See also: [Invidious, a front-end for YouTube.][invidious repo] + +[invidious repo]: https://github.com/omarroth/invidious ## Instances -The official instance is on https://bibliogram.art. +The official instance is on +[https://bibliogram.art](https://bibliogram.art). -Community instances are listed [on the wiki page](https://github.com/cloudrac3r/bibliogram/wiki/Instances). +Community instances are listed in [`docs/Instances.md`][instances]. +Submit a patchset to add your own instance to that list. -If you only use one computer, you can install Bibliogram on that computer and then access the instance through localhost. +[instances]: https://git.sr.ht/~cadence/bibliogram-docs/tree/main/docs/Instances.md ## Installing -Select a section and follow the instructions in that section only. +See [`docs/Installing (basic).md`][basic] and +[`docs/Installing (extended).md`][extended]. -### With bibliogram-updater - -**This is the best method to run Bibliogram on a server.** This method **will** automatically keep Bibliogram up to date, requiring no maintenance after the initial setup. - -The updater scripts run in fish. If installing fish isn't possible, please choose a different method. - -To clone Bibliogram, install dependencies, and automatically keep it up to date in future, run this in a shell: - - wget -O install-bibliogram.sh https://raw.githubusercontent.com/cloudrac3r/bibliogram-updater/master/.clone.sh - bash install-bibliogram.sh - -If you want more details, extended documentation, or want to use it without pasting code, please check out the project page: https://github.com/cloudrac3r/bibliogram-updater - -### With Docker - -I have no idea how Docker works. Good luck. You **won't** be automatically updated to new versions with this. - -[Discuss the Docker setup in issue #81](https://github.com/cloudrac3r/bibliogram/issues/81) and tell me about how I can make it more convenient for you, or even submit a pull request if you know what you want. - -Recommended: Clone the repo, then `docker-compose up`. - -Alternatively: `docker run -p 10407:10407 -v db:/app/db cloudrac3r/bibliogram`. - -[Repository on Docker Hub.](https://hub.docker.com/repository/docker/cloudrac3r/bibliogram) - -### Manually, if you've run webservers before - -**This is the best method to run Bibliogram if you're a developer.** You **won't** be automatically updated to new versions with this. - -1. Install [node.js](https://nodejs.org/en/) (^12.13.0 suggested) -1. `$ git clone https://github.com/cloudrac3r/bibliogram` -If you are currently looking at a fork, be sure to actually install that fork instead! -1. `$ cd bibliogram` -1. `$ npm install --no-optional` (for Tor support, omit `--no-optional`) -1. Edit `/config.js` to suit your environment -1. `$ npm start` - -Bibliogram is now running on `0.0.0.0:10407`. - -You _must_ configure `website_origin`. Read [Wiki:Configuring](https://github.com/cloudrac3r/bibliogram/wiki/Configuring) for help. - -### Manually, if you're new to running webservers - -You **won't** be automatically updated to new versions with this. - -Guide: [Wiki:Installing](https://github.com/cloudrac3r/bibliogram/wiki/Installing) - -Problems? [Wiki:Troubleshooting](https://github.com/cloudrac3r/bibliogram/wiki/Troubleshooting) - -You _must_ configure `website_origin`. Read [Wiki:Configuring](https://github.com/cloudrac3r/bibliogram/wiki/Configuring) for help. - -### With Heroku - -Don't deploy Bibliogram on Heroku. It's a really bad idea. Please read about the [ephemeral filesystem](https://devcenter.heroku.com/articles/active-storage-on-heroku#ephemeral-disk) which the database is stored on, and then read about [configuring with environment variables](https://github.com/cloudrac3r/bibliogram/wiki/Environment-variables), and then [read the rate limit documentation](https://github.com/cloudrac3r/bibliogram/wiki/Rate-limits), and then understand that Heroku will _never_ be unblocked because Instagram knows that because its IP address is from a cloud server it's going to be doing bad things. Despite these warnings, [you can still deploy on Heroku if you really want to.](https://heroku.com/deploy?template=https://github.com/cloudrac3r/bibliogram) +[basic]: https://git.sr.ht/~cadence/bibliogram-docs/tree/main/docs/Installing%20%28basic%29.md +[extended]: https://git.sr.ht/~cadence/bibliogram-docs/tree/main/docs/Installing%20%28extended%29.md ## Credits & license information -All of Bibliogram's code uses the [AGPL 3.0 license](https://choosealicense.com/licenses/agpl-3.0/). In short, this means that if you make any modifications to the code and then publish the result (e.g. by hosting the result on a webserver), you must publicly distribute your changes and declare that they also use AGPL 3.0. +All of Bibliogram's code uses the +[AGPL 3.0 license](https://choosealicense.com/licenses/agpl-3.0/). In +short, this means that if you make any modifications to the code and +then publish the result (e.g. by hosting the result on a webserver), +you must publicly distribute your changes and declare that they also +use AGPL 3.0. -Site banner by [TheFrenchGhosty](https://github.com/TheFrenchGhosty), [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) +[This documentation uses the Unlicense](https://unlicense.org/). -Site font is [Bariol](http://atipofoundry.com/fonts/bariol) by [atipo foundry](http://atipofoundry.com/), located in /src/site/html/static/fonts. Proprietary license, used with permission. See http://atipofoundry.com/license, section "webfont license". +Site banner by [TheFrenchGhosty](https://github.com/TheFrenchGhosty), +[CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) + +Site font is [Bariol](http://atipofoundry.com/fonts/bariol) by +[atipo foundry](http://atipofoundry.com/), located in +`/src/site/html/static/fonts` in the main repo. Proprietary license, +used with permission. See http://atipofoundry.com/license, section +"webfont license". diff --git a/app.json b/app.json index 2f9e557..ff9c9a0 100644 --- a/app.json +++ b/app.json @@ -1,6 +1,6 @@ { "name": "Bibliogram", "description": "An alternative front-end for Instagram.", - "repository": "https://github.com/cloudrac3r/bibliogram", + "repository": "https://git.sr.ht/~cadence/bibliogram", "logo": "https://bibliogram.art/android-chrome-192x192.png" } diff --git a/src/lib/constants.js b/src/lib/constants.js index deb3bbf..e7664cf 100644 --- a/src/lib/constants.js +++ b/src/lib/constants.js @@ -237,7 +237,7 @@ let constants = { }, resources: { - instances_wiki_raw: "https://raw.githubusercontent.com/wiki/cloudrac3r/bibliogram/Instances.md", + instances_wiki_raw: "https://git.sr.ht/~cadence/bibliogram-docs/blob/master/docs/Instances.md", saved_requests_location: "https://meta.bibliogram.art/saved_requests/" }, diff --git a/src/lib/utils/upgradedb.js b/src/lib/utils/upgradedb.js index 9ce1f74..4120e50 100644 --- a/src/lib/utils/upgradedb.js +++ b/src/lib/utils/upgradedb.js @@ -165,7 +165,7 @@ module.exports = async function() { +"\n -> Make sure you have set `config/website_origin`" +"\n as instructed in the installation guide." +"\n -> Consider adding yourself to the instance list:" - +"\n https://github.com/cloudrac3r/bibliogram/wiki/Instances" + +"\n https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Instances.md" +"\n -> Join the Matrix chatroom for help: #bibliogram:matrix.org" +"\n" ) diff --git a/src/site/api/instances.js b/src/site/api/instances.js index 6a5b587..782cdb6 100644 --- a/src/site/api/instances.js +++ b/src/site/api/instances.js @@ -67,7 +67,7 @@ module.exports = [ content: { status: "fail", generatedAt: Date.now(), - message: "Unable to parse the table from the wiki page: https://raw.githubusercontent.com/wiki/cloudrac3r/bibliogram/Instances.md" + message: `Unable to parse the table from the instances page at ${constants.resources.instances_wiki_raw}` } } } diff --git a/src/site/pug/blocked.pug b/src/site/pug/blocked.pug index 8fd693a..2cc56d4 100644 --- a/src/site/pug/blocked.pug +++ b/src/site/pug/blocked.pug @@ -32,7 +32,7 @@ html#bibliogram-identifier-blocked p #[a(href="/userscripts/unblock.user.js") Open this link.] You should be prompted to install the script. Press "Confirm installation" on that page. p Reload this page. li To learn more, #[a(href="https://github.com/cloudrac3r/bibliogram/wiki/Rate-limits#tldr-what-does-it-mean-if-an-instance-is-blocked") read about blocking.] - li You may be able to avoid this by #[a(href="https://github.com/cloudrac3r/bibliogram/wiki/Instances") browsing on another instance.] + li You may be able to avoid this by #[a(href="https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Instances.md") browsing on another instance.] li It's good to read scripts to see what they do. #[a(href=`${website_origin}/u/${username}/unblock.sh`) Read ./unblock.sh] a(href="/").back ↵ Return home diff --git a/src/site/pug/home.pug b/src/site/pug/home.pug index dee486d..ce575b6 100644 --- a/src/site/pug/home.pug +++ b/src/site/pug/home.pug @@ -53,9 +53,9 @@ html ul - const links = [ - ["https://github.com/cloudrac3r/bibliogram", "GitHub repository", "noopener"], + ["https://sr.ht/~cadence/bibliogram/", "Code on sourcehut", "noopener"], ["https://matrix.to/#/#bibliogram:matrix.org", "Discussion room on Matrix"], - ["https://github.com/cloudrac3r/bibliogram/wiki/Instances", "Other Bibliogram instances", "noopener"], + ["https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Instances.md", "Other Bibliogram instances", "noopener"], ["https://github.com/cloudrac3r/bibliogram/projects/1?fullscreen=true", "Project roadmap"], ["https://cadence.moe/about/contact", "Contact the developer"] ] diff --git a/src/site/pug/includes/error.pug b/src/site/pug/includes/error.pug index 21d1747..f21ec8c 100644 --- a/src/site/pug/includes/error.pug +++ b/src/site/pug/includes/error.pug @@ -6,5 +6,5 @@ mixin error(statusCode, message, withInstancesLink) if block block if withInstancesLink - a(href="https://github.com/cloudrac3r/bibliogram/wiki/Instances") You could try browsing Bibliogram on another instance. + a(href="https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Instances.md") You could try browsing Bibliogram on another instance. a(href="/").back ↵ Return home diff --git a/src/site/pug/includes/head.pug b/src/site/pug/includes/head.pug index 0fd7a2d..3f758a1 100644 --- a/src/site/pug/includes/head.pug +++ b/src/site/pug/includes/head.pug @@ -27,5 +27,5 @@ else Your theme value "#{theme}" wasn't understood. There is no loaded theme with that name. Please #[a(href="/settings") go to the settings page] and select a different theme. - If that doesn't help, #[a(href="https://github.com/cloudrac3r/bibliogram/issues/new") report a bug.] + If that doesn't help, #[a(href="https://todo.sr.ht/~cadence/bibliogram-issues") report a bug.] In your bug report, tell us which website address you saw this on, and what your theme value is.