lolisafe, a small safe worth protecting

safe.fiery.me branch

This branch is the one being used at https://safe.fiery.me. If you are looking for the original, head to master branch, or even better to WeebDev/lolisafe.

If you want to use an existing lolisafe database with this branch, make sure to run node database/migration.js at least once to create some new columns introduced in this branch.

Configuration file of lolisafe, config.js, is also NOT 100% compatible with this branch. There are some options that had been renamed and/or restructured. Please make sure your config matches the sample in config.sample.js before starting.

Missing thumbnails

Thumbnails will not be automatically generated for existing files that have been uploaded prior to enabling thumbnails generation in the config file.

To generate thumbnails for those files, you can try running node scripts/thumbs.js.

$ node scripts/thumbs.js

Generate thumbnails.

Usage  :
node scripts/thumbs.js <mode=1|2|3> [force=0|1] [verbose=0|1] [cfcache=0|1]

mode   : 1 = images only, 2 = videos only, 3 = both images and videos
force  : 0 = no force (default), 1 = overwrite existing thumbnails
verbose: 0 = only print missing thumbs (default), 1 = print all
cfcache: 0 = do not clear cloudflare cache (default), 1 = clear cloudflare cache

For example, if you only want to generate thumbnails for image files without overwriting existing ones (e.i. thumbnails of new files), you can run node scripts/thumbs.js 1.

ClamAV support

This fork has an optional virus scanning support using ClamAV, through clamdjs library.

It will scan new files right after they are uploaded. It will then print error messages to the uploaders (as in the virus names in ClamAV's databases) if the files are dirty.

On the down side, this will slow down uploads processing (as it has to wait for the scan results before responding the uploader's requests), however it's still highly recommended for public use.

To enable this, make sure you have ClamAV daemon running, then fill in the daemon's IP and port into your config file.

Running

1. Ensure you have at least version 8.0.0 of node installed
2. Clone the repo
3. Rename config.sample.js to config.js
4. Modify port, domain and privacy options if desired
5. run yarn install to install all dependencies (yes, use yarn)
6. run pm2 start lolisafe.js or node lolisafe.js to start the service

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.

The option serveFilesWithNode in the config.js dictates if you want lolisafe to serve the files or nginx/apache once they are uploaded. The main difference between the two is the ease of use and the chance of analytics in the future. If you set it to true, the uploaded files will be located after the host like: https://lolisafe.moe/yourFile.jpg

If you set it to false, you need to set nginx to directly serve whatever folder it is you are serving your downloads in. This also gives you the ability to serve them, for example, like this: https://files.lolisafe.moe/yourFile.jpg

Both cases require you to type the domain where the files will be served on the domain key below. Which one you use is ultimately up to you. Either way, I've provided a sample config files for nginx that you can use to set it up quickly and painlessly!

• Normal Version
• SSL Version

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.

Cloudflare Support

If you are running lolisafe behind Cloudflare there is support to make the NGINX logs have the users IP instead of Cloudflares IP. You will need to compile NGINX from source with --with-http_realip_module as well as uncomment the following line in the NGINX config: include /path/to/lolisafe/real-ip-from-cf;

Using lolisafe

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.

A sample of the returning json from the endpoint can be seen below:

{
  "name": "EW7C.png",
  "size": "71400",
  "url": "https://i.kanacchi.moe/EW7C.png"
}

To make it easier and better than any other service, you can download our Chrome extension. That will let you configure your hostname and tokens, so that you can simply right click -> loli-safe -> send to safe on any image/audio/video file on the web.

Because of how nodejs apps work, if you want it attached to a domain name you will need to make a reverse proxy for it.

Here is a tutorial on how to do this with nginx. Keep in mind that this is only a requirement if you want to access your lolisafe service by using a domain name (ex: https://i.kanacchi.moe), otherwise you can use the service just fine by accessing it from your server's IP.

Sites using lolisafe

Refer to the wiki

Author

lolisafe © Pitu, Released under the MIT License.

Authored and maintained by Pitu.

lolisafe.moe · GitHub @Pitu