About SerenumSelf-hosting
If you have access to a web server, you can install Serenum on it. Installation is simple: download or clone the repository, upload the files to the web server, and point the domain to the installation.
No API key is required thanks to the use of Open-Meteo.
System requirements
- Apache / Nginx
- PHP >8.4
- Composer
Installation
- Download the files and place the directory in the path specified by
rootinconfig.yml. - Open
config.ymland change the values underdefaultsas required. - Run
composer installorcomposer updatein the directory. - Point the web server to the directory.
- Go to
your-domain.com.
Updating
- Rename
config.ymltoconfig.yml.bak. - Download the files using your preferred method and replace all files in the directory.
- Rename
config.yml.bakback toconfig.yml.
Configuration
In config.yml, you can specify, amongst other things, the default settings that Serenum should use. Read the comments for each line to see which values are supported. Some lines also contain information about what the setting does.
Troubleshooting
Change debug in config.yml to 1 if you want to display error messages on the webpage. This may be useful if the page isn’t working properly, if you want to report issues, or if you want to contribute to the project.
If you wish to report a problem, please create a ticket. First, check whether the problem has already been reported in the existing tickets.
Designated place
You can enter the coordinates for a default location. If this option is selected, visitors will not be able to search for other locations, nor will they be able to change the latitude or longitude via the address bar.
Maximum number of API calls
By default, Serenum uses the same limits for API calls as Open-Meteo: 10,000 calls per day. Once this limit has been reached, no further calls are made to Open-Meteo, but the cache files continue to function.
Cache
By default, Serenum uses the same limits for API calls as Open-Meteo: 10,000 calls per day. Once this limit has been reached, no further calls are made to Open-Meteo, but the cache files continue to function.
Please note that Serenum will then fetch new data from Open-Meteo every time the page is loaded, which increases the number of API calls.
Serenum updates weather data every 30 minutes.
Once the limit of 10,000 requests has been reached, further access to the Open-Meteo API will be blocked until the following day. Open-Meteo applies the following limits:
- 600 calls per minute
- 5,000 calls per hour
- 10,000 calls per day
Things to bear in mind
HTTPS is required for GPS
Location data is sensitive information and must therefore be sent over a secure connection via HTTPS (HyperText Transfer Protocol Secure).
If the device cannot be located using standard GPS, Wi-Fi and/or mobile data will be used, depending on the system settings the user has enabled. On Android and iOS, GPS, Wi-Fi and mobile data are normally used for positioning.
HTTPS protects the connection against eavesdropping and tampering.
No offline mode – yet
Cached weather data can quickly become out of date, as the weather is dynamic and changes frequently throughout the day. For this reason, we have not yet prioritised a fully offline mode.
However, there are plans to make Serenum more offline-friendly in the future, as cache files can, in practice, remain valid for up to an hour, even though we currently update them twice an hour.