Lomanic/bibliogram
1
0
Fork 0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-16 05:07:29 +00:00
Code Issues Releases Wiki Activity
3cbe4647e1
bibliogram/README.md
Cadence Ember 09a747e315
Update Heroku notes and credits link
2020-06-09 00:12:49 +12:00

3.6 KiB
Raw Blame History

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.

You can see a list of instances run by the community 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

Quick setup, if you've run webservers before:

  1. Install node.js (^12.13.0 suggested)
  2. $ git clone https://github.com/cloudrac3r/bibliogram
    If you are using 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 server environment
  6. $ npm start

Bibliogram is now running on 0.0.0.0:10407.

After installing, you must configure website_origin. See Wiki:Installing and Wiki:Configuring for more details. Problems? Wiki:Troubleshooting

You can also deploy on Heroku, though I personally would not recommend this, because Heroku's filesystem is ephemeral, and the database is saved as a file, which means saved settings and the cache will be lost when the dyno restarts, which Heroku does automatically every few hours. In addition, configuration options must be set via environment variables because, again, the configuration file does not persist (unless you fork the repository, make your changes as commits, push them to Heroku, and then manually manage and merge future commits to upstream Bibliogram). Despite this warning, you can still deploy on Heroku if you 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".