YunoHost-Apps/microbin_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/microbin_ynh.git synced 2024-09-03 19:45:57 +02:00
Code Issues Activity Actions

Update .env

Browse source
This commit is contained in:
Éric Gaspar 2024-06-16 23:26:53 +02:00
parent 7f5400638d
commit 8461588e88
1 changed files with 41 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
conf/.env
View file

@ -6,7 +6,7 @@
# https://username@yourserver.net if password is not set # https://username@yourserver.net if password is not set
# instead of typing into the password # instead of typing into the password
# Default value: unset # Default value: unset
# export MICROBIN_BASIC_AUTH_USERNAME= # MICROBIN_BASIC_AUTH_USERNAME=
# Require password for HTTP Basic Authentication when # Require password for HTTP Basic Authentication when
# visiting the service. Will not have any affect unless # visiting the service. Will not have any affect unless
@ -17,14 +17,14 @@
# https://username@yourserver.net if password is not set # https://username@yourserver.net if password is not set
# instead of typing into the password prompt. # instead of typing into the password prompt.
# Default value: unset # Default value: unset
# export MICROBIN_BASIC_AUTH_PASSWORD= # MICROBIN_BASIC_AUTH_PASSWORD=
# Enables administrator interface at yourserver.com/admin/ # Enables administrator interface at yourserver.com/admin/
# if set, disables it if unset. If admin username is set but # if set, disables it if unset. If admin username is set but
# admin password is not, just leave the password field empty # admin password is not, just leave the password field empty
# when logging in. # when logging in.
# Default value: admin # Default value: admin
export MICROBIN_ADMIN_USERNAME=__ADMIN__ MICROBIN_ADMIN_USERNAME=__ADMIN__
# Enables administrator interface at yourserver.com/admin/ # Enables administrator interface at yourserver.com/admin/
# if set, disables it if unset. Will not have any affect # if set, disables it if unset. Will not have any affect
@ -32,76 +32,76 @@ export MICROBIN_ADMIN_USERNAME=__ADMIN__
# set but admin password is not, just leave the password # set but admin password is not, just leave the password
# field empty when logging in. # field empty when logging in.
# Default value: m1cr0b1n # Default value: m1cr0b1n
export MICROBIN_ADMIN_PASSWORD=__PASSWORD__ MICROBIN_ADMIN_PASSWORD=__PASSWORD__
# Enables editable pastas. You will still be able to make # Enables editable pastas. You will still be able to make
# finalised pastas but there will be an extra checkbox to # finalised pastas but there will be an extra checkbox to
# make your new pasta editable from the pasta list or the # make your new pasta editable from the pasta list or the
# pasta view page. # pasta view page.
# Default value: 8080 # Default value: 8080
export MICROBIN_EDITABLE=true MICROBIN_EDITABLE=true
# Replaces the default footer text with your own. If you # Replaces the default footer text with your own. If you
# want to hide the footer, use the hide footer option instead. # want to hide the footer, use the hide footer option instead.
# Note that you can also embed HTML here, so you may want to escape # Note that you can also embed HTML here, so you may want to escape
# '<', '>' and so on. # '<', '>' and so on.
# export MICROBIN_FOOTER_TEXT= # MICROBIN_FOOTER_TEXT=
# Hides the navigation bar on every page. # Hides the navigation bar on every page.
# Default value: 8080 # Default value: 8080
export MICROBIN_HIDE_HEADER=false MICROBIN_HIDE_HEADER=false
# Hides the footer on every page. # Hides the footer on every page.
# Default value: 8080 # Default value: 8080
export MICROBIN_HIDE_FOOTER=false MICROBIN_HIDE_FOOTER=false
# Hides the MicroBin logo from the navigation bar on every # Hides the MicroBin logo from the navigation bar on every
# page. # page.
# Default value: 8080 # Default value: 8080
export MICROBIN_HIDE_LOGO=false MICROBIN_HIDE_LOGO=false
# Disables the /pastalist endpoint, essentially making all # Disables the /pastalist endpoint, essentially making all
# pastas private. # pastas private.
# Default value: 8080 # Default value: 8080
export MICROBIN_NO_LISTING=false MICROBIN_NO_LISTING=false
# Enables syntax highlighting support. When creating a new # Enables syntax highlighting support. When creating a new
# pasta, a new dropdown selector will be added where you can # pasta, a new dropdown selector will be added where you can
# select your pasta's syntax, or just leave it empty for no # select your pasta's syntax, or just leave it empty for no
# highlighting. # highlighting.
export MICROBIN_HIGHLIGHTSYNTAX=true MICROBIN_HIGHLIGHTSYNTAX=true
# Sets the port for the server will be listening on. # Sets the port for the server will be listening on.
# Default value: 8080 # Default value: 8080
export MICROBIN_PORT=__PORT__ MICROBIN_PORT=__PORT__
# Sets the bind address for the server will be listening on. # Sets the bind address for the server will be listening on.
# Both ipv4 and ipv6 are supported. Default value: "0.0.0.0". # Both ipv4 and ipv6 are supported. Default value: "0.0.0.0".
# Example value: "myserver.net", "127.0.0.1". # Example value: "myserver.net", "127.0.0.1".
export MICROBIN_BIND="127.0.0.1" MICROBIN_BIND="127.0.0.1"
# Enables private pastas. Adds a new checkbox to make your # Enables private pastas. Adds a new checkbox to make your
# pasta private, which then won't show up on the pastalist # pasta private, which then won't show up on the pastalist
# page. With the URL to your pasta, it will still be # page. With the URL to your pasta, it will still be
# accessible. # accessible.
# Default value: false # Default value: false
export MICROBIN_PRIVATE=true MICROBIN_PRIVATE=true
# DEPRECATED: Will be removed soon. If you want to change styling (incl. removal), use custom CSS variable instead. # DEPRECATED: Will be removed soon. If you want to change styling (incl. removal), use custom CSS variable instead.
# Disables main CSS styling, just uses a few in-line # Disables main CSS styling, just uses a few in-line
# stylings for the layout. With this option you will lose # stylings for the layout. With this option you will lose
# dark-mode support. # dark-mode support.
export MICROBIN_PURE_HTML=false MICROBIN_PURE_HTML=false
# Sets the name of the directory where MicroBin creates # Sets the name of the directory where MicroBin creates
# its database and stores attachments. # its database and stores attachments.
# Default value: microbin_data # Default value: microbin_data
export MICROBIN_DATA_DIR="__DATA_DIR__" MICROBIN_DATA_DIR="__DATA_DIR__"
# Enables storing pasta data (not attachments and files) in # Enables storing pasta data (not attachments and files) in
# a JSON file instead of the SQLite database. # a JSON file instead of the SQLite database.
# Default value: false # Default value: false
export MICROBIN_JSON_DB=false MICROBIN_JSON_DB=false
# Add the given public path prefix to all urls. This allows # Add the given public path prefix to all urls. This allows
# you to host MicroBin behind a reverse proxy on a subpath. # you to host MicroBin behind a reverse proxy on a subpath.
@ -109,7 +109,7 @@ export MICROBIN_JSON_DB=false
# as without this option, and thus is unsuited if you are # as without this option, and thus is unsuited if you are
# running MicroBin directly. Default value: unset. Example # running MicroBin directly. Default value: unset. Example
# values: https://myserver.com/ or https://192.168.0.10:8080/ # values: https://myserver.com/ or https://192.168.0.10:8080/
export MICROBIN_PUBLIC_PATH=https://__DOMAIN____PATH__/ MICROBIN_PUBLIC_PATH=https://__DOMAIN____PATH__/
# Sets a shortened path to use when the user copies URL from # Sets a shortened path to use when the user copies URL from
# the application. This will also use shorter endpoints, # the application. This will also use shorter endpoints,
@ -119,82 +119,82 @@ export MICROBIN_PUBLIC_PATH=https://__DOMAIN____PATH__/
# The password required for uploading, if read-only mode is enabled # The password required for uploading, if read-only mode is enabled
# Default value: unset # Default value: unset
# export MICROBIN_UPLOADER_PASSWORD= # MICROBIN_UPLOADER_PASSWORD=
# If set to true, authentication required for uploading # If set to true, authentication required for uploading
# Default value: false # Default value: false
export MICROBIN_READONLY=true MICROBIN_READONLY=true
# Enables showing read count on pasta pages. # Enables showing read count on pasta pages.
# Default value: false # Default value: false
export MICROBIN_SHOW_READ_STATS=true MICROBIN_SHOW_READ_STATS=true
# Adds your title of choice to the # Adds your title of choice to the
# navigation bar. # navigation bar.
# Default value: unset # Default value: unset
# export MICROBIN_TITLE= # MICROBIN_TITLE=
# Number of workers MicroBin is allowed to have. Increase # Number of workers MicroBin is allowed to have. Increase
# this to the number of CPU cores you have if you want to go # this to the number of CPU cores you have if you want to go
# beast mode, but for personal use one worker is enough. # beast mode, but for personal use one worker is enough.
# Default value: 1. # Default value: 1.
export MICROBIN_THREADS=1 MICROBIN_THREADS=1
# Sets the garbage collector time limit. Pastas not accessed # Sets the garbage collector time limit. Pastas not accessed
# for N days are removed even if they are set to never # for N days are removed even if they are set to never
# expire. # expire.
# Default value: 90. # Default value: 90.
# To turn off GC: 0. # To turn off GC: 0.
export MICROBIN_GC_DAYS=90 MICROBIN_GC_DAYS=90
# Enables or disables the "Burn after" function # Enables or disables the "Burn after" function
# Default value: false # Default value: false
export MICROBIN_ENABLE_BURN_AFTER=true MICROBIN_ENABLE_BURN_AFTER=true
# Sets the default burn after setting on the main screen. # Sets the default burn after setting on the main screen.
# Default value: 0. Available expiration options: 1, 10, # Default value: 0. Available expiration options: 1, 10,
# 100, 1000, 10000, 0 (= no limit) # 100, 1000, 10000, 0 (= no limit)
export MICROBIN_DEFAULT_BURN_AFTER=0 MICROBIN_DEFAULT_BURN_AFTER=0
# Changes the maximum width of the UI from 720 pixels to # Changes the maximum width of the UI from 720 pixels to
# 1080 pixels. # 1080 pixels.
# Default value: false # Default value: false
export MICROBIN_WIDE=false MICROBIN_WIDE=false
# Enables generating QR codes for pastas. Requires # Enables generating QR codes for pastas. Requires
# the public path to also be set. # the public path to also be set.
# Default value: false # Default value: false
export MICROBIN_QR=true MICROBIN_QR=true
# Toggles "Never" expiry settings for pastas. Default # Toggles "Never" expiry settings for pastas. Default
# value: false # value: false
export MICROBIN_ETERNAL_PASTA=false MICROBIN_ETERNAL_PASTA=false
# Enables "Read-only" uploads. These are unlisted and # Enables "Read-only" uploads. These are unlisted and
# unencrypted, but can be viewed without password if you # unencrypted, but can be viewed without password if you
# have the URL. Editing and removing requires password. # have the URL. Editing and removing requires password.
# Default value: true # Default value: true
export MICROBIN_ENABLE_READONLY=true MICROBIN_ENABLE_READONLY=true
# Sets the default expiry time setting on the main screen. # Sets the default expiry time setting on the main screen.
# Default value: 24hour Available expiration options: 1min, # Default value: 24hour Available expiration options: 1min,
# 10min, 1hour, 24hour, 1week, never # 10min, 1hour, 24hour, 1week, never
export MICROBIN_DEFAULT_EXPIRY=24hour MICROBIN_DEFAULT_EXPIRY=24hour
# Disables and hides the file upload option in the UI. # Disables and hides the file upload option in the UI.
# Default value: false # Default value: false
export MICROBIN_NO_FILE_UPLOAD=false MICROBIN_NO_FILE_UPLOAD=false
# Replaced the built-in water.css stylesheet with the URL # Replaced the built-in water.css stylesheet with the URL
# you provide. Default value: unset. Example value: # you provide. Default value: unset. Example value:
# https://myserver.net/public/mystyle.css # https://myserver.net/public/mystyle.css
# export MICROBIN_CUSTOM_CSS= # MICROBIN_CUSTOM_CSS=
# Use short hash strings in the URLs instead of animal names # Use short hash strings in the URLs instead of animal names
# to make URLs shorter. Does not change the underlying data # to make URLs shorter. Does not change the underlying data
# stored, just how pastas are recalled. # stored, just how pastas are recalled.
# Default value: false # Default value: false
export MICROBIN_HASH_IDS=false MICROBIN_HASH_IDS=false
# Enables server-side encryption. This will add private # Enables server-side encryption. This will add private
# privacy level, where the user sends plain unencrypted data # privacy level, where the user sends plain unencrypted data
@ -202,36 +202,36 @@ export MICROBIN_HASH_IDS=false
# server sees everything that the user submits, therefore # server sees everything that the user submits, therefore
# the user does not have complete and absolute protection. # the user does not have complete and absolute protection.
# Default value: false # Default value: false
export MICROBIN_ENCRYPTION_CLIENT_SIDE=true MICROBIN_ENCRYPTION_CLIENT_SIDE=true
# Enables client-side encryption. This will add the secret # Enables client-side encryption. This will add the secret
# privacy level where the user's browser encrypts all data # privacy level where the user's browser encrypts all data
# with JavaScript before sending it over to MicroBin, which # with JavaScript before sending it over to MicroBin, which
# encrypt the data once again on server side. # encrypt the data once again on server side.
# Default value: false # Default value: false
export MICROBIN_ENCRYPTION_SERVER_SIDE=true MICROBIN_ENCRYPTION_SERVER_SIDE=true
# Limit the maximum file size users can upload without # Limit the maximum file size users can upload without
# encryption. Default value: 256. # encryption. Default value: 256.
export MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB=256 MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB=256
# Limit the maximum file size users can upload with # Limit the maximum file size users can upload with
# encryption (more strain on your server than without # encryption (more strain on your server than without
# encryption, so the limit should be lower. Secrets tend to # encryption, so the limit should be lower. Secrets tend to
# be tiny files usually anyways.) Default value: 2048. # be tiny files usually anyways.) Default value: 2048.
export MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB=2048 MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB=2048
# Disables the feature that checks for available updates # Disables the feature that checks for available updates
# when opening the admin screen. # when opening the admin screen.
# Default value: false # Default value: false
export MICROBIN_DISABLE_UPDATE_CHECKING=false MICROBIN_DISABLE_UPDATE_CHECKING=false
# Disables telemetry if set to true. # Disables telemetry if set to true.
# Telemetry includes your configuration and helps development. # Telemetry includes your configuration and helps development.
# It does not include any sensitive data. # It does not include any sensitive data.
# Default value: false # Default value: false
export MICROBIN_DISABLE_TELEMETRY=true MICROBIN_DISABLE_TELEMETRY=true
# Enables listing your server in the public MicroBin server list. # Enables listing your server in the public MicroBin server list.
# Default value: false # Default value: false
export MICROBIN_LIST_SERVER=false MICROBIN_LIST_SERVER=false