aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPitu <[email protected]>2020-07-18 02:21:31 +0900
committerPitu <[email protected]>2020-07-18 02:21:31 +0900
commit2d06d918a154c15196ca92fb8f7873ca3c797f00 (patch)
tree085c8998b86a0cb00ed3030124bfdf463d9ea4ef /README.md
parentUpdated TODO (diff)
downloadhost.fuwn.me-2d06d918a154c15196ca92fb8f7873ca3c797f00.tar.xz
host.fuwn.me-2d06d918a154c15196ca92fb8f7873ca3c797f00.zip
Timeout, package and docs cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 6 insertions, 11 deletions
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.<br>