• Options to configure
  • host
  • port
  • root
  • username
  • password
  • cache
  • root-path and uds
  • logs
  • dotall
  • dependencies
  • web-ui
• Configuration via CLI
• Configuration via config.ini
  • Example Configuration File
    • .ini specification

Options to configure

note: your can also use man fileporter (after installation)

host

where to bind to

• 0.0.0.0 means globally (can be access over the local internet)
• 127.0.0.1 means locally (only the host-machine can access the site)

default: 0.0.0.0

port

which port to bind to

recommended ports:

• 80 (often times blocked by some software or the system)
• 3000
• 5000
• 5050 (sometimes blocked by other software)
• 8000
• 8080 (sometimes blocked by other software)

note: 80 is the default port to allow url’s without port (eg http://10.20.30.40/ instead of http://10.20.30.40:8000/) but is often blocked by some software or the system. That’s why it’s recommended to use 3000, 5000 or 8000

default: 8000

root

the directory which should be served

default: . (current working directory)

username

which username the authentication process requires

note: only works if password is supplied

default: default to currently logged in user

password

which password the authentication process requires

it is possible to provide the sha256-hexdigest hashed version of the password. This password-version has to begin with hash: and can be generated with make password-encryption PW="[YOUR PASSWORD]". This is meant for you to not store/use your plain password and is recommended to use.

note: if password is yes|true it falls back to the system-password of the current user

default: no authentication

cache

fileporter cached previews or low-resolution versions of files in a cache directory. (This gets cleared every system-start)

If your don’t want the cache because of security or other reasons you can disable this option.
note: this requires more system-resources

default: true

root-path and uds

this options are helpful if fileporter should run behind a reverse-proxy like nginx

this option must start and end with an / (eg /fileporter/ or /served/fileporter/)

{ .important }

note: your need to make your own web-ui build

links for more information:

• uvicorn: running-behind-nginx
• fastapi: behind a proxy

default: not used

logs

whether or not to log startup and access information

default: no

dotall

files that start with . are not shown in the UI. This is UNIX behavior that this files are marked as “hidden”. If your want to see them you have to enable them here.

default: no

dependencies

whether or not to show missing dependencies for previews during the startup process

default: no

web-ui

custom directory to use for the frontend (related to root-path-option and custom starting url)

default: {APP}/web-ui/

Configuration via CLI

see fileporter --help for more information

Configuration via config.ini

{. note }

you can specify a path a config.ini file with the --config CLI options

• ~/.config/fileporter/config.ini
• /etc/fileporter/config.ini

Example Configuration File

[SERVER]
;host: 0.0.0.0
;port: 8000
;root: .
;username: 
;password: 

[CUSTOMIZATION]
;cache: no
;web-ui: ${HOME}/fileporter-custom/

[PROXY]
;root-path: /custom/
;uds: /tmp/fileporter.sock

[DEBUG]
;logs: yes
;dotall: yes
;dependencies: yes

.ini specification

; Comment like this
# or like this

# separate key and value like this
key: value
key = value  # the space is irrelevant (but try to keep a standard)
key=value  # btw. this is an inline comment

key:
    multiline values
    are allowed

# you can also use interpolation
path: src
file: ${path}/file.txt