From 2d06d918a154c15196ca92fb8f7873ca3c797f00 Mon Sep 17 00:00:00 2001 From: Pitu Date: Sat, 18 Jul 2020 02:21:31 +0900 Subject: Timeout, package and docs cleanup --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6c9433f..0f531c3 100644 --- a/README.md +++ b/README.md @@ -8,33 +8,28 @@ 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` package installed and at least at version 10 -- `build-essential` package installed to build some dependencies -- `ffmpeg` package installed if you want thumbnails +- `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 -- A database, postgresql preferably. You can also fall back to sqlite3 by default. +- `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` -4. Run `yarn migrate` -5. Run `yarn seed` 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. -After you finish setting up nginx, you need to start lolisafe by using pm2. If you want to use something else, figure out how. (More info on why pm2 [here](docs/pm2.md)) +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. 7. Run `pm2 start pm2.json`: 8. Profit -### Cloudflare - -If you want to run your site through CloudFlare because of the obvious advantages it has, lolisafe has your back. Unless you manually modify the `.env` file, uploads through the website will be uploaded in chunks thus bypassing CloudFlare's 100mb upload limit per file. - ## Author **lolisafe** © [Pitu](https://github.com/Pitu), Released under the [MIT](https://github.com/WeebDev/lolisafe/blob/master/LICENSE) License.
-- cgit v1.2.3 From 91507249c040e34a2eab878b6e40dcabe7710a5c Mon Sep 17 00:00:00 2001 From: Pitu Date: Sat, 18 Jul 2020 16:40:21 +0900 Subject: Update readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0f531c3..452ae6f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ [![Support me](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fpitu&style=flat-square)](https://www.patreon.com/pitu) [![Support me](https://img.shields.io/badge/Support-Buy%20me%20a%20coffee-yellow.svg?style=flat-square)](https://www.buymeacoffee.com/kana) +### 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](docs/migration.md). + ### Pre-requisites This guide asumes a lot of things, including that you know your way around linux, nginx and internet in general. -- cgit v1.2.3 From d3b7321bf6ce651721d7081ec2740bd5df3a6746 Mon Sep 17 00:00:00 2001 From: Pitu Date: Sat, 18 Jul 2020 16:41:08 +0900 Subject: whoops --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 452ae6f..330a542 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Support me](https://img.shields.io/badge/Support-Buy%20me%20a%20coffee-yellow.svg?style=flat-square)](https://www.buymeacoffee.com/kana) ### 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](docs/migration.md). +If you are upgrading from v3 to v4 (current release) and you want to keep your files and relations please read the [migration guide](docs/migrating.md). ### Pre-requisites This guide asumes a lot of things, including that you know your way around linux, nginx and internet in general. -- cgit v1.2.3