@samitouri / QOSami-HFS / commits / 6d842a5e

docs: better

Massimo Melina committed May 31, 2023 at 22:06 UTC 6d842a5ec7b349c6d91586718fea16bb58bfe023
2 files changed +6 -3
README.md
+2 -2
@@ -179,8 +179,8 @@ While this project focuses on ease of use, we care about security.
179 Some actions you can take for improved security:
180 - use https, better if using a proper certificate, even free with [Letsencrypt](https://letsencrypt.org/).
181 - have a domain (ddns is ok too), start vhosting plugin, configure your domain, enable "Block requests that are not using any of the domains above"
182 -- install/start rejetto/antidos plugin. Tweak configuration if necessary.
183 -- start antibrute plugin (it's started by default)
182 +- install rejetto/antidos plugin
183 +- start antibrute plugin (but it's started by default)
184 - disable "unprotected admin on localhost"
185
186 ## Hidden features
dev-plugins.md
+4 -1
@@ -238,7 +238,10 @@ This is a list of available frontend-events, with respective object parameter an
238
239 ## Other files
240
241 -Together with the main file (plugin.js), you can have
241 +Together with the main file (plugin.js), you can have other files, both for data and javascript to include with `require('./other-file')`.
242 +Notice that in this case you don't use `api.require` but classic `require` because it's in your plugin folder.
243 +
244 +These files have a special meaning:
245
246 - `public` folder, and its files will be accessible at `/~/plugins/PLUGIN_NAME/FILENAME`
247 - `custom.html` file, that works exactly like the main `custom.html`. Even when same section is specified