~cadence/bibliogram-docs

bibliogram-docs/docs/Installing (basic).md -rw-r--r-- 3.0 KiB
b8fe859eCadence Ember Add Ethibox instance (thanks johackim) 21 days ago

#Installing

Choose 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 see how to use the updater, please go to the updater repo.

#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://git.sr.ht/~cadence/bibliogram
  3. $ cd bibliogram
  4. $ npm install --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 docs/Configuring.md for more details.

#Manually, if you're new to running webservers

You won't be automatically updated to new versions with this.

Guide: docs/Installing (extended).md

Problems? docs/Troubleshooting.md

You must configure website_origin. Read docs/Configuring.md for more details.

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