1
0
mirror of https://git.sr.ht/~cadence/bibliogram synced 2024-11-22 16:17:29 +00:00
bibliogram/README.md

48 lines
2.9 KiB
Markdown
Raw Normal View History

2020-01-28 14:43:48 +00:00
# [Bibliogram](https://bibliogram.art)
2020-01-12 12:50:21 +00:00
2020-03-25 10:22:54 +00:00
[![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)
2020-01-12 12:50:21 +00:00
## 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.
2020-05-21 10:41:21 +00:00
See Bibliogram's features: [Wiki:Features](https://github.com/cloudrac3r/bibliogram/wiki/Features)
2020-01-12 12:50:21 +00:00
2020-03-25 10:22:54 +00:00
Join the Bibliogram discussion room on Matrix: [#bibliogram:matrix.org](https://matrix.to/#/#bibliogram:matrix.org)
2020-01-26 15:34:10 +00:00
2020-05-21 10:29:42 +00:00
See also: [Invidious, a front-end for YouTube.](https://github.com/omarroth/invidious)
2020-01-26 15:34:10 +00:00
2020-01-12 12:50:21 +00:00
## Instances
2020-01-28 14:43:48 +00:00
The official instance is on https://bibliogram.art.
You can see a list of instances run by the community [on the wiki page](https://github.com/cloudrac3r/bibliogram/wiki/Instances).
2020-01-12 12:50:21 +00:00
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:
2020-01-14 14:44:45 +00:00
1. Install [node.js](https://nodejs.org/en/) (^12.13.0 suggested)
1. `$ git clone https://github.com/cloudrac3r/bibliogram`
2020-01-14 14:44:45 +00:00
If you are using a fork, be sure to actually install that fork instead!
1. `$ cd bibliogram`
2020-02-02 11:43:56 +00:00
1. `$ npm install --no-optional` (for Tor support, omit `--no-optional`)
2020-01-14 14:44:45 +00:00
1. Edit `/config.js` to suit your server environment
1. `$ npm start`
2020-01-12 12:50:21 +00:00
Bibliogram is now running on `0.0.0.0:10407`.
2020-05-08 15:19:31 +00:00
After installing, you _must_ configure `website_origin`. See [Wiki:Installing](https://github.com/cloudrac3r/bibliogram/wiki/Installing) and [Wiki:Configuring](https://github.com/cloudrac3r/bibliogram/wiki/Configuring) for more details. Problems? [Wiki:Troubleshooting](https://github.com/cloudrac3r/bibliogram/wiki/Troubleshooting)
2020-05-08 15:19:31 +00:00
You can also deploy on Heroku, though I personally would not recommend this. [Get started with Heroku.](https://heroku.com/deploy?template=https://github.com/cloudrac3r/bibliogram)
2020-04-14 16:01:11 +00:00
2020-02-22 11:27:23 +00:00
## Credits & license information
2020-01-28 14:43:48 +00:00
2020-05-21 10:29:42 +00:00
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.
2020-01-28 14:43:48 +00:00
Site banner by [TheFrenchGhosty](https://gitlab.com/TheFrenchGhosty), [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
2020-02-22 11:27:23 +00:00
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".