1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-14 04:17:30 +00:00
bibliogram/README.md
2020-05-09 03:19:31 +12:00

3.6 KiB

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 also: Invidious, a front-end for YouTube.

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

Features

  • View profile and timeline
  • Infinite scroll
  • User memory cache
  • RSS (latest 12 posts)
  • View post
  • Galleries
  • Homepage
  • Videos
  • Galleries of videos
  • Optimised for mobile
  • Instance list
  • Clickable usernames and hashtags
  • Proper error checking
  • Favicon
  • Image disk cache
  • Settings (e.g. data saving)
  • List view
  • IGTV
  • Test suite
  • Rate limiting
  • Public API
  • Explore hashtags
  • Explore locations
  • more...?

These features may not be able to be implemented for technical reasons:

  • Stories

These features will not be added, unless you ask reallllly nicely:

  • Comments
  • Tagging users

These features will not be added, and I will not investigate adding them:

  • Viewing or interacting with a private profile's timeline

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. Get started with Heroku.

User-facing endpoints

  • / - homepage
  • /u/{username} - load a user's profile and timeline
  • /u/{username}/rss.xml - get the RSS feed for a user
  • /u/{username}/atom.xml - get the Atom feed for a user
  • /p/{shortcode} - load a post
  • /privacy - privacy policy

Credits & license information

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