Skip to content

Commit

Permalink
📝 Add documentation for the website config options
Browse files Browse the repository at this point in the history
Signed-off-by: Marcus Fihlon <[email protected]>
  • Loading branch information
McPringle committed Nov 2, 2024
1 parent 758c5be commit e61ee7f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,28 @@ METANET_DATABASE_PASSWORD=verysecred

When these settings are not blank, the import will start automatically ten seconds after the launch of *Komunumo*.

### Website

Every website needs some basic configuration. Have a look at the following configuration options, most of which are self-describing:

```
WEBSITE_URL=http://localhost:8080
WEBSITE_ASSOCIATION=User Group Name
WEBSITE_ABOUT_TEXT=Tell the world what this user group is about.
WEBSITE_CONTACT_ADDRESS=12345 Foobar
WEBSITE_CONTACT_EMAIL=noreply@localhost
WEBSITE_COPYRIGHT=© User Group Name
WEBSITE_LOGO_TEMPLATE=http://localhost/images/logo_%02d.png
WEBSITE_LOGO_MIN=1
WEBSITE_LOGO_MAX=10
```

[!NOTE]
> The configuration option `WEBSITE_ABOUT_TEXT` is allowed to contain HTML code! So you can use paragraphs and links, if needed.
[!IMPORTANT]
> The logo handling is very special: If you want to specify only one logo, just use the URL and set the `MIN` and `MAX` values to `0`. Done. But if you want *Komunumo* to pick a random logo on every request, you can specify a logo template which must contain a String format argument for a decimal integer representation (like `%02d` for a two-digit number in the example above). In addition, set the `MIN` and `MAX` values as needed. *Komunumo* will randomly pick a number between the provided `MIN` and `MAX` values and merge it with the provided `TEMPLATE` to create the image URL.
## Build

### Maven
Expand Down

0 comments on commit e61ee7f

Please sign in to comment.