microbin icon indicating copy to clipboard operation
microbin copied to clipboard

Some Documentation Errors in Configuration

Open xNinjaKittyx opened this issue 2 years ago • 1 comments

Describe the bug There's some documentation mixups for the variables I think. https://microbin.eu/docs/installation-and-configuration/configuration/

It'd also be helpful if the formatting was something like


MICROBIN_ADMIN_USERNAME

Default value: admin Enables administrator interface at yourserver.com/admin/ if set, disables it if unset. If admin username is set but admin password is not, just leave the password field empty when logging in.


Personally this is a bit more clear and easier to view at a glance.

MICROBIN_ENCRYPTION_CLIENT_SIDE
Enables server-side encryption. This will add private privacy level, where the user sends plain unencrypted data (still secure, because you use HTTPS, right?), but the server sees everything that the user submits, therefore the user does not have complete and absolute protection. Default value: false

MICROBIN_ENCRYPTION_SERVER_SIDE
Enables client-side encryption. This will add the secret privacy level where the user's browser encrypts all data with JavaScript before sending it over to MicroBin, which encrypt the data once again on server side. Default value: false

I think it's supposed to be the other way around?

Same thing here

MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB
Limit the maximum file size users can upload without encryption. Default value: 256.

MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB
Limit the maximum file size users can upload with encryption (more strain on your server than without encryption, so the limit should be lower. Secrets tend to be tiny files usually anyways.) Default value: 2048.

For sake of consistency, there's a few that have = signs next to them

MICROBIN_UPLOADER_PASSWORD=
The password required for uploading, if read-only mode is enabled Default value: unset

...

MICROBIN_DISABLE_UPDATE_CHECKING=false
Disables the feature that checks for available updates when opening the admin screen. Default value: false

MICROBIN_DISABLE_TELEMETRY=false
Disables telemetry if set to true. Telemetry includes your configuration and helps development. It does not include any sensitive data. Default value: false

EDIT: Also a small side-note, it would be appreciated if you could also list how you're doing the encryption somewhere in the docs.

xNinjaKittyx avatar Jul 12 '23 22:07 xNinjaKittyx

It really nuked my brain when I first saw MICROBIN_ENCRYPTION_CLIENT_SIDE and MICROBIN_ENCRYPTION_SERVER_SIDE

dongdigua avatar Aug 04 '23 00:08 dongdigua