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 /docs | |
| 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 'docs')
| -rw-r--r-- | docs/migrating.md | 17 | ||||
| -rw-r--r-- | docs/pm2.md | 11 |
2 files changed, 17 insertions, 11 deletions
diff --git a/docs/migrating.md b/docs/migrating.md new file mode 100644 index 0000000..9166581 --- /dev/null +++ b/docs/migrating.md @@ -0,0 +1,17 @@ +### Migrate from v3 to v4 +This version introduces a few breaking changes and updating requires some manual work. +For starters we recommend cloning the new version somewhere else instead of `git pull` on your v3 version. + +- After cloning move your `uploads` folder from the v3 folder to the new v4 folder. +- Then copy your `database/db` file from your v3 folder to the root of your v4 folder. +- You then need to run `yarn setup` or `npm start setup` from the v4 folder and finish the setup process. +- Once that's done you need to manually run `node src/api/databaseMigration.js` from the root folder of v4. +- This will migrate the v3 database to v4 and regenerate every single thumbnail in webp to save bandwidth. +- After the migration finishes, the last step is to update your nginx config with the [newly provided script](./nginx.md). +- Restart nginx with `sudo nginx -s reload`. +- And lastly start your lolisafe instance with `pm2 start pm2.json`. + +### Breaking changes +- If you are using the lolisafe extension from one of the stores, the new version has been submitted and could take up to a week to get approved. In the meantime you can load the unpacked extension by cloning [this repo](https://github.com/WeebDev/loli-safe-extension). +- The lolisafe browser extension needs your new token. Instead of pasting your jwt token into it like before, you need to log in to lolisafe, go to your user settings and generate an `API KEY`, which you will use to access the service from 3rd party apps like the browser extension, ShareX, etc. +- To upload a file to an album directly users used to use the endpoint `/api/upload/${albumId}`. This is no longer the case. To upload directly to an album now it's necessary to pass a header called `albumid` with an integer as the value of the album to which you want to upload the file to. diff --git a/docs/pm2.md b/docs/pm2.md deleted file mode 100644 index ac942fc..0000000 --- a/docs/pm2.md +++ /dev/null @@ -1,11 +0,0 @@ -## Setting up PM2 to run lolisafe - -The best way to keep the service running in case of crashes or unexpected issues is to attach the process to PM2 and forget about it. This also gives you the ability to dettach the process from your terminal and run it in the background, which is a must since lolisafe now comes in 2 separate processes. -The recommended way to set it up is to run the commands below, one for the API and the other for the site. - -``` -pm2 start npm --name "lolisafe-api" -- run api -pm2 start npm --name "lolisafe-site" -- run site -``` - -All set, if you want to check the logs you can `pm2 logs lolisafe-api` or similar. |