v3.0.0/README.md

2.2 KiB

lolisafe GitHub license Chat / Support Support me Support me

Attention

If you are upgrading from v3 to v4 (current release) and you want to keep your files and relations please read the migration guide.

Pre-requisites

This guide asumes a lot of things, including that you know your way around linux, nginx and internet in general.

  • Decently updated version of linux
  • node version 12+
  • build-essential package installed to build dependencies
  • ffmpeg package installed if you want video thumbnails
  • yarn package installed. If you'd like to use npm instead change package.json accordingly
  • pm2 globally installed (npm i -g pm2) to keep the service alive at all times.
  • A database, postgresql preferably. You can also fall back to sqlite3 which ships by default.

Installing

  1. Clone the repository and cd into it
  2. Run yarn install
  3. Run yarn setup

Lolisafe is now installed, configured and ready. Now you need to serve it to the public by using a domain name.

  1. Check the nginx file for a sample configuration that has every step to run lolisafe securely on production.

After you finish setting up nginx, you need to start lolisafe by using pm2. If you want to use something else like forever, ensure that the process spawned from npm run start never dies.

  1. Run pm2 start pm2.json:
  2. Profit

Author

lolisafe © Pitu, Released under the MIT License.
Authored and maintained by Pitu.

lolisafe.moe · GitHub @Pitu