@@ -32,6 +32,17 @@ The machine you want to deploy LEAF-Writer on also needs to have `git` installed
...
@@ -32,6 +32,17 @@ The machine you want to deploy LEAF-Writer on also needs to have `git` installed
# Updating LEAF-Writer
# Updating LEAF-Writer
From time to time it may be desirable to update LEAF-Writer and its dependencies for a variety of reasons like benefiting from new features and to get security updates. The later is especially important regarding Keycloak, the software that manages the access to identity providers like GitHub / GitLab. A security issue in Keycloak may lead to unauthorized access to GitHub / GitLab accounts of LEAF-Writer users!
To update LEAF-Writer and its components do the following:
1. dsf
2. dffsdf
3. dsfdsfdsf
## Upgrading the Keycloak database server
# Geonames Username
# Geonames Username
LEAF-Writer can query a number of databases to link annotations to identifiers provided by authorities like GND, Wikidata and so on. For geographic information the authority provider is [Geonames](https://www.geonames.org). To query the Geonames API a username is necessary. The username is used to enforce a rate limit and is just appended as plain text to the query, which is not very secure. This username can hardly be kept a secret and if you search this repository, you will find ours. However, it would not be nice to reuse the username of somebody else and add additional queries to their rate limit. Therefore, when deploying LEAF-Writer you must obtain your own Geonames username, by creating [an account](https://www.geonames.org/login). After completing the procedure you take the username you choose and put it in the `leafwriter.env`-file as `GEONAMES_USERNAME`.
LEAF-Writer can query a number of databases to link annotations to identifiers provided by authorities like GND, Wikidata and so on. For geographic information the authority provider is [Geonames](https://www.geonames.org). To query the Geonames API a username is necessary. The username is used to enforce a rate limit and is just appended as plain text to the query, which is not very secure. This username can hardly be kept a secret and if you search this repository, you will find ours. However, it would not be nice to reuse the username of somebody else and add additional queries to their rate limit. Therefore, when deploying LEAF-Writer you must obtain your own Geonames username, by creating [an account](https://www.geonames.org/login). After completing the procedure you take the username you choose and put it in the `leafwriter.env`-file as `GEONAMES_USERNAME`.