66# https://username@yourserver.net if password is not set
77# instead of typing into the password
88# Default value: unset
9- # export MICROBIN_BASIC_AUTH_USERNAME=
9+ # MICROBIN_BASIC_AUTH_USERNAME=
1010
1111# Require password for HTTP Basic Authentication when
1212# visiting the service. Will not have any affect unless
1717# https://username@yourserver.net if password is not set
1818# instead of typing into the password prompt.
1919# Default value: unset
20- # export MICROBIN_BASIC_AUTH_PASSWORD=
20+ # MICROBIN_BASIC_AUTH_PASSWORD=
2121
2222# Enables administrator interface at yourserver.com/admin/
2323# if set, disables it if unset. If admin username is set but
2424# admin password is not, just leave the password field empty
2525# when logging in.
2626# Default value: admin
27- export MICROBIN_ADMIN_USERNAME = admin
27+ MICROBIN_ADMIN_USERNAME = admin
2828
2929# Enables administrator interface at yourserver.com/admin/
3030# if set, disables it if unset. Will not have any affect
3131# unless admin username is also set. If admin username is
3232# set but admin password is not, just leave the password
3333# field empty when logging in.
3434# Default value: m1cr0b1n
35- export MICROBIN_ADMIN_PASSWORD = m1cr0b1n
35+ MICROBIN_ADMIN_PASSWORD = m1cr0b1n
3636
3737# Enables editable pastas. You will still be able to make
3838# finalised pastas but there will be an extra checkbox to
3939# make your new pasta editable from the pasta list or the
4040# pasta view page.
4141# Default value: true
42- export MICROBIN_EDITABLE = true
42+ MICROBIN_EDITABLE = true
4343
4444# Replaces the default footer text with your own. If you
4545# want to hide the footer, use the hide footer option instead.
4646# Note that you can also embed HTML here, so you may want to escape
4747# '<', '>' and so on.
48- # export MICROBIN_FOOTER_TEXT=
48+ # MICROBIN_FOOTER_TEXT=
4949
5050# Hides the navigation bar on every page.
5151# Default value: false
52- export MICROBIN_HIDE_HEADER = false
52+ MICROBIN_HIDE_HEADER = false
5353
5454# Hides the footer on every page.
5555# Default value: false
56- export MICROBIN_HIDE_FOOTER = false
56+ MICROBIN_HIDE_FOOTER = false
5757
5858# Hides the MicroBin logo from the navigation bar on every
5959# page.
6060# Default value: false
61- export MICROBIN_HIDE_LOGO = false
61+ MICROBIN_HIDE_LOGO = false
6262
6363# Disables the /pastalist endpoint, essentially making all
6464# pastas private.
6565# Default value: false
66- export MICROBIN_NO_LISTING = false
66+ MICROBIN_NO_LISTING = false
6767
6868# Enables syntax highlighting support. When creating a new
6969# pasta, a new dropdown selector will be added where you can
7070# select your pasta's syntax, or just leave it empty for no
7171# highlighting.
72- export MICROBIN_HIGHLIGHTSYNTAX = true
72+ MICROBIN_HIGHLIGHTSYNTAX = true
7373
7474# Sets the port for the server will be listening on.
7575# Default value: 8080
76- export MICROBIN_PORT = 8080
76+ MICROBIN_PORT = 8080
7777
7878# Sets the bind address for the server will be listening on.
7979# Both ipv4 and ipv6 are supported. Default value: "0.0.0.0".
8080# Example value: "myserver.net", "127.0.0.1".
81- export MICROBIN_BIND = " 0.0.0.0"
81+ MICROBIN_BIND = " 0.0.0.0"
8282
8383# Enables private pastas. Adds a new checkbox to make your
8484# pasta private, which then won't show up on the pastalist
8585# page. With the URL to your pasta, it will still be
8686# accessible.
8787# Default value: true
88- export MICROBIN_PRIVATE = true
88+ MICROBIN_PRIVATE = true
8989
9090# DEPRECATED: Will be removed soon. If you want to change styling (incl. removal), use custom CSS variable instead.
9191# Disables main CSS styling, just uses a few in-line
9292# stylings for the layout. With this option you will lose
9393# dark-mode support.
94- export MICROBIN_PURE_HTML = false
94+ MICROBIN_PURE_HTML = false
9595
9696# Sets the name of the directory where MicroBin creates
9797# its database and stores attachments.
9898# Default value: microbin_data
99- export MICROBIN_DATA_DIR = " microbin_data"
99+ MICROBIN_DATA_DIR = " microbin_data"
100100
101101# Enables storing pasta data (not attachments and files) in
102102# a JSON file instead of the SQLite database.
103103# Default value: false
104- export MICROBIN_JSON_DB = false
104+ MICROBIN_JSON_DB = false
105105
106106# Add the given public path prefix to all urls. This allows
107107# you to host MicroBin behind a reverse proxy on a subpath.
108108# Note that MicroBin itself still expects all routes to be
109109# as without this option, and thus is unsuited if you are
110110# running MicroBin directly. Default value: unset. Example
111111# values: https://myserver.com/ or https://192.168.0.10:8080/
112- # export MICROBIN_PUBLIC_PATH=
112+ # MICROBIN_PUBLIC_PATH=
113113
114114# Sets a shortened path to use when the user copies URL from
115115# the application. This will also use shorter endpoints,
@@ -119,130 +119,130 @@ export MICROBIN_JSON_DB=false
119119
120120# The password required for uploading, if read-only mode is enabled
121121# Default value: unset
122- # export MICROBIN_UPLOADER_PASSWORD=
122+ # MICROBIN_UPLOADER_PASSWORD=
123123
124124# If set to true, authentication required for uploading
125125# Default value: false
126- export MICROBIN_READONLY = false
126+ MICROBIN_READONLY = false
127127
128128# Enables showing read count on pasta pages.
129129# Default value: false
130- export MICROBIN_SHOW_READ_STATS = true
130+ MICROBIN_SHOW_READ_STATS = true
131131
132132# Adds your title of choice to the
133133# navigation bar.
134134# Default value: unset
135- # export MICROBIN_TITLE=
135+ # MICROBIN_TITLE=
136136
137137# Number of workers MicroBin is allowed to have. Increase
138138# this to the number of CPU cores you have if you want to go
139139# beast mode, but for personal use one worker is enough.
140140# Default value: 1.
141- export MICROBIN_THREADS = 1
141+ MICROBIN_THREADS = 1
142142
143143# Sets the garbage collector time limit. Pastas not accessed
144144# for N days are removed even if they are set to never
145145# expire.
146146# Default value: 90.
147147# To turn off GC: 0.
148- export MICROBIN_GC_DAYS = 90
148+ MICROBIN_GC_DAYS = 90
149149
150150# Enables or disables the "Burn after" function
151151# Default value: false
152- export MICROBIN_ENABLE_BURN_AFTER = true
152+ MICROBIN_ENABLE_BURN_AFTER = true
153153
154154# Sets the default burn after setting on the main screen.
155155# Default value: 0. Available expiration options: 1, 10,
156156# 100, 1000, 10000, 0 (= no limit)
157- export MICROBIN_DEFAULT_BURN_AFTER = 0
157+ MICROBIN_DEFAULT_BURN_AFTER = 0
158158
159159# Changes the maximum width of the UI from 720 pixels to
160160# 1080 pixels.
161161# Default value: false
162- export MICROBIN_WIDE = false
162+ MICROBIN_WIDE = false
163163
164164# Enables generating QR codes for pastas. Requires
165165# the public path to also be set.
166166# Default value: false
167- export MICROBIN_QR = true
167+ MICROBIN_QR = true
168168
169169# Toggles "Never" expiry settings for pastas. Default
170170# value: false
171- export MICROBIN_ETERNAL_PASTA = false
171+ MICROBIN_ETERNAL_PASTA = false
172172
173173# Enables "Read-only" uploads. These are unlisted and
174174# unencrypted, but can be viewed without password if you
175175# have the URL. Editing and removing requires password.
176176# Default value: true
177- export MICROBIN_ENABLE_READONLY = true
177+ MICROBIN_ENABLE_READONLY = true
178178
179179# Sets the default expiry time setting on the main screen.
180180# Default value: 24hour Available expiration options: 1min,
181181# 10min, 1hour, 24hour, 1week, never
182- export MICROBIN_DEFAULT_EXPIRY = 24hour
182+ MICROBIN_DEFAULT_EXPIRY = 24hour
183183
184184# Disables and hides the file upload option in the UI.
185185# Default value: false
186- export MICROBIN_NO_FILE_UPLOAD = false
186+ MICROBIN_NO_FILE_UPLOAD = false
187187
188188# Replaced the built-in water.css stylesheet with the URL
189189# you provide. Default value: unset. Example value:
190190# https://myserver.net/public/mystyle.css
191- # export MICROBIN_CUSTOM_CSS=
191+ # MICROBIN_CUSTOM_CSS=
192192
193193# Use short hash strings in the URLs instead of animal names
194194# to make URLs shorter. Does not change the underlying data
195195# stored, just how pastas are recalled.
196196# Default value: false
197- export MICROBIN_HASH_IDS = false
197+ MICROBIN_HASH_IDS = false
198198
199199# Enables server-side encryption. This will add private
200200# privacy level, where the user sends plain unencrypted data
201201# (still secure, because you use HTTPS, right?), but the
202202# server sees everything that the user submits, therefore
203203# the user does not have complete and absolute protection.
204204# Default value: false
205- export MICROBIN_ENCRYPTION_CLIENT_SIDE = true
205+ MICROBIN_ENCRYPTION_CLIENT_SIDE = true
206206
207207# Enables client-side encryption. This will add the secret
208208# privacy level where the user's browser encrypts all data
209209# with JavaScript before sending it over to MicroBin, which
210210# encrypt the data once again on server side.
211211# Default value: false
212- export MICROBIN_ENCRYPTION_SERVER_SIDE = true
212+ MICROBIN_ENCRYPTION_SERVER_SIDE = true
213213
214214# Limit the maximum file size users can upload without
215215# encryption. Default value: 256.
216- export MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB = 256
216+ MICROBIN_MAX_FILE_SIZE_ENCRYPTED_MB = 256
217217
218218# Limit the maximum file size users can upload with
219219# encryption (more strain on your server than without
220220# encryption, so the limit should be lower. Secrets tend to
221221# be tiny files usually anyways.) Default value: 2048.
222- export MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB = 2048
222+ MICROBIN_MAX_FILE_SIZE_UNENCRYPTED_MB = 2048
223223
224224# Disables the feature that checks for available updates
225225# when opening the admin screen.
226226# Default value: false
227- export MICROBIN_DISABLE_UPDATE_CHECKING = false
227+ MICROBIN_DISABLE_UPDATE_CHECKING = false
228228
229229# Enables telemetry if set to true. Telemetry is now OPT-IN for privacy.
230230# Telemetry includes your configuration and helps development.
231231# It does not include any sensitive data.
232232# Default value: false (disabled by default)
233- # export MICROBIN_ENABLE_TELEMETRY=false
233+ # MICROBIN_ENABLE_TELEMETRY=false
234234
235235# Custom telemetry server URL. Only used if telemetry is enabled.
236236# Set this to your own telemetry server to avoid sending data to microbin.eu
237237# Default value: https://api.microbin.eu/telemetry/
238238# Examples:
239239# MICROBIN_TELEMETRY_URL=https://your-server.com/telemetry/
240240# MICROBIN_TELEMETRY_URL=http://localhost:8090/telemetry/
241- # export MICROBIN_TELEMETRY_URL=https://api.microbin.eu/telemetry/
241+ # MICROBIN_TELEMETRY_URL=https://api.microbin.eu/telemetry/
242242
243243# Enables listing your server in the public MicroBin server list.
244244# Default value: false
245- export MICROBIN_LIST_SERVER = false
245+ MICROBIN_LIST_SERVER = false
246246
247247
248248# Controls the log level for debugging and troubleshooting.
@@ -254,4 +254,4 @@ export MICROBIN_LIST_SERVER=false
254254# MICROBIN_LOG=trace - Show all logs (most verbose)
255255# MICROBIN_LOG=microbin=debug - Only debug logs from microbin modules
256256# Default value: info (set in the application)
257- # export MICROBIN_LOG=info
257+ # MICROBIN_LOG=info
0 commit comments