mirror of
https://github.com/BobbyWibowo/lolisafe.git
synced 2024-12-15 00:46:22 +00:00
c3d61733af
Added iamdustan/smoothscroll polyfill in dashboard pages. This will polyfill smooth scroll (when executed programmatically) for older browers. No-JS uploader's notice button when on private mode will now also say "Log in to upload", although auth page will still require JS. All front-end buttons will now use outlined version. I'm lovin' it. Auth page will now show a loading spinner if the user has a saved token. Afterwards, they will still be redirected to dashboard. Better error handlers in home, dashboard, and auth pages. Removed <hr> from uploads & users lists in dashboard. "Manage your token" menu will no longer try to make an API request prior to displaying its page. Reloading the page will already trigger token verification anyway. Updated public/images/fb_share.png. Updated README.md. A few other tweaks.
80 lines
4.4 KiB
Markdown
80 lines
4.4 KiB
Markdown
# lolisafe, a small safe worth protecting
|
|
|
|
[](https://safe.fiery.me)
|
|
|
|
[](https://raw.githubusercontent.com/WeebDev/lolisafe/master/LICENSE)
|
|
|
|
## `safe.fiery.me`
|
|
|
|
[](https://github.com/standard/standard)
|
|
|
|
This fork is the one being used at [https://safe.fiery.me](https://safe.fiery.me). If you are looking for the original, head to [WeebDev/lolisafe](https://github.com/WeebDev/lolisafe).
|
|
|
|
If you want to use an existing lolisafe database with this fork, run `node ./database/migration.js` 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
|
|
|
|
1. Ensure you have at least Node v8.0.0 installed (v10.x is recommended).
|
|
2. Clone this repo.
|
|
3. Copy `config.sample.js` as `config.js`.
|
|
4. Modify port, domain and privacy options if desired.
|
|
5. Run `yarn install --production` to install all production dependencies (Yes, use [yarn](https://yarnpkg.com)).
|
|
6. Run `yarn start` to start the service.
|
|
|
|
You can also start it with `yarn pm2` if you have [PM2](https://pm2.keymetrics.io/).
|
|
|
|
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 `src` directory.
|
|
|
|
The pre-built files were processed with [postcss-preset-env](https://github.com/csstools/postcss-preset-env), [cssnano](https://github.com/cssnano/cssnano), [bublé](https://github.com/bublejs/buble), and [terser](https://github.com/terser/terser).
|
|
|
|
## 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](https://github.com/gulpjs/gulp#what-is-gulp) tasks.
|
|
|
|
1. Follow step 1 to 4 from the production instructions above.
|
|
2. Run `yarn install` to install all dependencies (including development ones).
|
|
3. Run `yarn develop` to start the service in development mode.
|
|
|
|
You can configure the Gulp tasks through `gulpfile.js` file.
|
|
|
|
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 `dist` directory.
|
|
|
|
## Script for missing thumbnails
|
|
|
|
Thumbnails will not be automatically generated for existing files, that had been uploaded prior to enabling thumbnails in the config file.
|
|
|
|
To generate thumbnails for those files, you can use `yarn thumbs`.
|
|
|
|
```none
|
|
$ 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
|
|
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`.
|
|
|
|
## ClamAV support
|
|
|
|
This fork has an optional virus scanning support using [ClamAV](https://www.clamav.net/), through [clamdjs](https://github.com/NingLin-P/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 usage.
|
|
|
|
To enable this, make sure you have ClamAV daemon running, then fill in the daemon's IP and port into your config file.
|