2019-03-07 16:45:22 +01:00
[](https://raw.githubusercontent.com/kanadeko/Kuro/master/LICENSE)
[](https://discord.gg/5g6vgwn)
[](https://www.patreon.com/pitu)
[](https://www.buymeacoffee.com/kana)
### 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
2020-07-17 19:21:31 +02:00
- `node` version 12+
- `build-essential` package installed to build dependencies
- `ffmpeg` package installed if you want video thumbnails
2019-03-07 16:45:22 +01:00
- `yarn` package installed. If you'd like to use npm instead change `package.json` accordingly
2020-07-17 19:21:31 +02:00
- `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.
2019-03-07 16:45:22 +01:00
### 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.
6. Check the [nginx ](docs/nginx.md ) file for a sample configuration that has every step to run lolisafe securely on production.
2020-07-17 19:21:31 +02:00
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.
2019-03-12 05:45:47 +01:00
7. Run `pm2 start pm2.json` :
2019-03-07 16:45:22 +01:00
8. Profit
## Author
**lolisafe** © [Pitu ](https://github.com/Pitu ), Released under the [MIT ](https://github.com/WeebDev/lolisafe/blob/master/LICENSE ) License.< br >
Authored and maintained by Pitu.
> [lolisafe.moe](https://lolisafe.moe) · GitHub [@Pitu](https://github.com/Pitu)
