diff --git a/README.md b/README.md index 808f39d..288e410 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ ![loli-safe](https://a.cuntflaps.me/jcutlz.png) -# loli-safe -A small safe worth protecting. ---- -### Sites using loli-safe +# lolisafe, a small safe worth protecting. +## Sites using loli-safe - [lolisafe.moe](https://lolisafe.moe): A small safe worth protecting. - [cuntflaps.me](https://cuntflaps.me) - [fluntcaps.me](https://fluntcaps.me) - Feel free to add yours here. ---- -### What's new in v2.2.0 - +## What's new in v2.2.0 - Creation of public link for sharing a gallery - Ability to add your own html files without making git dirty (Check [this commit](https://github.com/WeebDev/loli-safe/commit/18c66d27fb580ed0f847f11525d2d2dca0fda2f4)) - Thumbnail creation for .webm and .mp4 (Thanks to [PascalTemel](https://github.com/PascalTemel)) @@ -34,22 +30,20 @@ db.schema.table('albums', function (table) { }) ``` ---- - +## Running 1. Clone 2. Rename `config.sample.js` to `config.js` 4. Modify port, basedomain and privacy options if desired 3. run `npm install` to install all dependencies 5. run `pm2 start lolisafe.js` or `node lolisafe.js` to start the service -### Getting started +## Getting started This service supports running both as public and private. The only difference is that one needs a token to upload and the other one doesn't. If you want it to be public so anyone can upload files either from the website or API, just set the option `private: false` in the `config.js` file. In case you want to run it privately, you should set `private: true`. Upon running the service for the first time, it's gonna create a user account with the username `root` and password `root`. This is your admin account and you should change the password immediately. This account will let you manage all uploaded files and remove any if necessary. If you set `enableUserAccounts: true`, people will be able to create accounts on the service to keep track of their uploaded files and create albums to upload stuff to, pretty much like imgur does, but only through the API. Every user account has a token that the user can use to upload stuff through the API. You can find this token on the section called `Change your token` on the administration dashboard, and if it gets leaked or compromised you can renew it by clicking the button titled `Request new token`. ---- ## Using loli-safe Once the service starts you can start hitting the upload endpoint at `/api/upload` with any file. If you're using the frontend to do so then you are pretty much set, but if using the API to upload make sure the form name is set to `files[]` and the form type to `multipart/form-data`. If the service is running in private mode, dont forget to send a header of type `token: YOUR-CLIENT-TOKEN` to validate the request.