1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-22 08:07:30 +00:00
Go to file
2020-07-09 21:43:40 +12:00
art Update art 2020-05-10 03:18:23 +12:00
scripts Make import script tell you what's happening 2020-07-07 22:01:24 +12:00
src Link to correct section in rate limits document 2020-07-09 20:56:55 +12:00
test Automatically download test files when required 2020-07-07 22:08:47 +12:00
.config.js.default Add .config.js.default 2020-07-08 18:09:52 +12:00
.dockerignore Update dockerfiles 2020-07-08 18:12:44 +12:00
.gitignore Add new test files 2020-07-07 22:02:10 +12:00
.npmrc Add loglevel silent npmrc 2020-05-25 03:29:57 +12:00
.taprc Add screenshot tester 2020-06-21 04:09:36 +12:00
app.json Correctly replace logo link in app.json 2020-04-15 04:02:13 +12:00
config.js New constants/config merge system 2020-01-28 16:14:21 +13:00
docker-compose.yml Update dockerfiles 2020-07-08 18:12:44 +12:00
Dockerfile Update dockerfiles 2020-07-08 18:12:44 +12:00
jsconfig.json Cache some semi-static data 2020-05-04 23:50:54 +12:00
LICENSE Add AGPL 3.0 license 2020-01-28 01:36:27 +13:00
package-lock.json Add screenshot tester 2020-06-21 04:09:36 +12:00
package.json Add screenshot tester 2020-06-21 04:09:36 +12:00
Procfile Hopefully support Heroku 2020-04-15 02:03:38 +12:00
README.md Update installing section in readme 2020-07-09 21:43:40 +12:00

Bibliogram

Humane Tech badge. GitHub Discussion on Matrix.

An alternative front-end for Instagram.

Bibliogram works without client-side JavaScript, has no ads or tracking, and doesn't urge you to sign up.

See Bibliogram's features: Wiki:Features

Join the Bibliogram discussion room on Matrix: #bibliogram:matrix.org

See also: Invidious, a front-end for YouTube.

Instances

The official instance is on https://bibliogram.art.

Community instances are listed on the wiki page.

If you only use one computer, you can install Bibliogram on that computer and then access the instance through localhost.

Installing

Select a section and follow the instructions in that section only.

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 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.

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 (^12.13.0 suggested)
  2. $ git clone https://github.com/cloudrac3r/bibliogram
    If you are currently looking at a fork, be sure to actually install that fork instead!
  3. $ cd bibliogram
  4. $ npm install --no-optional (for Tor support, omit --no-optional)
  5. Edit /config.js to suit your environment
  6. $ npm start

Bibliogram is now running on 0.0.0.0:10407.

You must configure website_origin. Read 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

Problems? Wiki:Troubleshooting

You must configure website_origin. Read Wiki:Configuring for help.

With Heroku

Don't deploy Bibliogram on Heroku. It's a really bad idea. Please read about the ephemeral filesystem which the database is stored on, and then read about configuring with environment variables, and then read the rate limit documentation, 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.

Credits & license information

All of Bibliogram's code uses the AGPL 3.0 license. 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, CC BY-NC-SA 4.0

Site font is Bariol by atipo foundry, located in /src/site/html/static/fonts. Proprietary license, used with permission. See http://atipofoundry.com/license, section "webfont license".