This program needs access to a postgresql database and redis database. When running the program on a single node together with postgresql and redis, 512M RAM and a reasonably modern CPU core should be enough.

You can get the program in one of the three ways:

• Pre-compiled binary for linux-amd64 and linux-arm64 are available in the release page
• Image from Docker hub
• Build it yourself.

You can run the gen-config command to generate an empty copy of config file with comments. You can then use -c <config_toml_file_path> to load it.

In docker builds, /app/config.toml will be automatically loaded if it exists and no other -c values are sepcified.

Postgresql and redis related configs are required.

A storage backend needs to be configured before people can upload files. Currently it supports S3 compatible sotrage, file system storage, WebDAV storage, with other support comming later. Feel free to open PRs for new storage backends.

The program can use storage backends configured either in the config file or in database, but not both. Storing the storage configs in the config file makes it easier to run multiple nodes that needs access to the same storage systems. Storing the storage configs in the db is easier for single node deployment and as it can be configured through the UI. (You'll need site_owner role to access the config page, see Assign user to site_owner role)

Currently users needs to manually run migrate command to create tables in the database. Automated migration may be added in the future.

run the serve command to start the server.

If you have user system enabled, you can use add-user-to-group --group-key site_owenr --user-email <useremail> to mark you user as site admin. This allows you to configure storage backends from the UI.