diff options
| author | Zephyrrus <[email protected]> | 2020-07-19 22:35:59 +0300 |
|---|---|---|
| committer | Zephyrrus <[email protected]> | 2020-07-19 22:35:59 +0300 |
| commit | 645b62b81dc46b2e2bdea0fbe30c36c4e0ff4a48 (patch) | |
| tree | 4c454e816b699ead53d225afadfb528649d126f7 /README.md | |
| parent | feat: Start working on a new album/tags/image info modal (diff) | |
| parent | Update setup script (diff) | |
| download | host.fuwn.me-645b62b81dc46b2e2bdea0fbe30c36c4e0ff4a48.tar.xz host.fuwn.me-645b62b81dc46b2e2bdea0fbe30c36c4e0ff4a48.zip | |
Merge branch 'dev' into dev-zephy
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 9 insertions, 11 deletions
@@ -4,37 +4,35 @@ [](https://www.patreon.com/pitu) [](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/migrating.md). + ### 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` 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> |