Note: sqlite3 JS dep version is currently fixed as there was no binary available during build
|2 years ago|
|.github||2 years ago|
|controllers||2 years ago|
|database||2 years ago|
|dist||2 years ago|
|pages/error||2 years ago|
|public||2 years ago|
|routes||2 years ago|
|scripts||2 years ago|
|src||2 years ago|
|views||2 years ago|
|.browserslistrc||3 years ago|
|.dockerignore||2 years ago|
|.editorconfig||5 years ago|
|.env.example||2 years ago|
|.eslintignore||3 years ago|
|.eslintrc.js||2 years ago|
|.gitignore||2 years ago|
|.stylelintignore||3 years ago|
|.stylelintrc.json||2 years ago|
|AUTHORS||3 years ago|
|Dockerfile||2 years ago|
|LICENSE||5 years ago|
|README.md||2 years ago|
|config.sample.js||2 years ago|
|docker-compose.yaml||2 years ago|
|gulpfile.js||2 years ago|
|logger.js||2 years ago|
|lolisafe.js||2 years ago|
|nginx-ssl.sample.conf||3 years ago|
|nginx.docker.conf||2 years ago|
|nginx.sample.conf||2 years ago|
|package.json||2 years ago|
|real-ip-from-cf||2 years ago|
|renovate.json||2 years ago|
|yarn.lock||2 years ago|
lolisafe, a small safe worth protecting
If you want to use an existing lolisafe database with this fork, run
node ./database/migration.js (or
yarn migrate) at least once to create the new columns introduced in this branch (don't forget to make a backup).
Configuration file of lolisafe,
config.js, is also NOT fully compatible with this fork. 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.
Running in production mode
- Ensure you have at least Node v10.x installed (v12.x works fine, but v14.x will likely have issues for now).
- Clone this repo.
- Modify port, domain and privacy options if desired.
yarn install --productionto install all production dependencies (Yes, use yarn).
yarn startto start the service.
Default admin account:
You can also start it with
yarn pm2 if you have PM2.
When running in production mode, the safe will use pre-built client-side CSS/JS files from
dist directory, while the actual source codes are in
Running in development mode
This fork has a separate development mode, with which client-side CSS/JS files in
src directory will be automatically rebuilt using Gulp tasks.
- Follow step 1 to 4 from the production instructions above.
yarn installto install all dependencies (including development ones).
yarn developto start the service in development mode.
You can configure the Gulp tasks through
During development, the rebuilt files will be saved in
dist-dev directory instead of
dist directory. The service will also automatically serve the files from
dist-dev directory instead. This is to avoid your IDE's Git from unnecessarily rebuilding diff of the modified files.
Once you feel like your modifications are ready for production usage, you can then run
yarn build to build production-ready files that will actually go to
If you are submitting a Pull Request, running
yarn buildbefore pushing the commit is NOT necessary. As long as the changes already work well in development mode, you may push the commit as-is.
This fork uses GitHub Actions to automatically rebuild client assets after every commit that modifies the source files in
Failing to build dependencies
Some dependencies may fail to build with Python 2.x, in particular
If that happens, I recommend building dependencies with Python 3.x instead.
To force Python 3.x for dependencies building, you can choose to create a file named
.npmrc in your lolisafe root directory, and fill it with:
Or you can try the alternative solutions listed in here: https://github.com/nodejs/node-gyp#configuring-python-dependency.
Note: Despite the file being named
.npmrc, that preference will also be used when installing dependencies with
yarn, so I still recommend sticking with it.
Updating when you have modified some files
Try to use git stash.
Basically you'll be doing this:
git stashto stash away your changes.
git pullto pull updates.
yarn install --production) to install dependencies matching the updated
git stash pop(or
git stash apply) to restore your changes.
Be warned that some files may have been updated too heavily that they will require manual merging.
If you only do some small modifications such as editing
views/_globals.njk and not much else, it's generally safe to do this even in a live production environment. But it's still best practice to at least review just what have been updated, and whether you will need to do some manual merging beforehand.
Still, I heavily recommend simply forking this repository and manually merging upstream changes whenever you feel like doing so. Read more about syncing a fork.
Afterwards, you can instead clone your fork in your production server and pull updates from there. You can then choose to only install production dependencies with
yarn install --production there (hint: this is how I setup safe.rita.moe).
Script for missing thumbnails
Thumbnails will not be automatically generated for files that were uploaded before enabling thumbnails generation in the config file.
To generate thumbnails for those files, you can use
$ yarn thumbs $ 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, 2 = print nothing 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, you can run
yarn thumbs 1, or if you want to generate thumbnails for both image and video files, while also overwriting existsing ones, you can run
yarn thumbs 3 1.
You will also need to use this script to overwrite existing thumbnails if you want to change thumbnail size.
It will scan new files right after they are uploaded. It will then alert the uploaders of the virus names in ClamAV's database if their files are dirty.
Unfortunately, this will slow down uploads processing as it has to wait for the scans before responding the uploaders. However, it's still highly recommended for public usage, or if you're like me who find the constant buzzing from Google Safe Search too annoying.
To enable this, make sure you have ClamAV installed, or additionally have ClamAV daemon running. Afterwards configure
uploads.scan options, and more importantly its sub-option
clamOptions. Read more about it in the
Additionally, you can also configure usergroups bypass, extensions whitelist, and max file size, to lessen the burden on your server.