Configuration

Configuration

This section describes each section in the configuration file and what it does. As this project is built on the Spring Boot framework, you may want to consult their official configuration documentation for more information.

Webserver Specific Properties

These properties control the behavior of the web server.

server.port=8080

Specifies the port on which the app runs.

server.ssl.enabled=true

Enables HTTPS if set to true.

server.ssl.key-store-type=PKCS12

Specifies the format used for the keystore. JKS can be used if it is a JKS file.

server.ssl.key-store=path/to/your/key.store

Specifies the path to the keystore containing the certificate.

server.ssl.key-store-password=password

Specifies the password used to generate the certificate.

server.ssl.key-alias=certificate

Specifies the alias mapped to the certificate.

SQL Specific Properties

These properties control the SQL connection for the app.

pagepulse.database.queryTimeout=30

Specifies the timeout in seconds for a query.

pagepulse.database.connection=jdbc:sqlite:./database.db

Specifies your JDBC connection string. If you want to use an in-memory database, set this to jdbc:sqlite::memory:

pagepulse.database.tablePrefix=pagepulse_

Specifies a table prefix for each created table.

pagepulse.database.cleanupInterval=15

Specifies the interval in which this app tries to delete old entries from the database.

pagepulse.database.entryLimit=10

Specifies the maximum number of entries allowed in the history table.

Social Connections

These properties control connections to social media platforms. If you set these to nothing, they will not be displayed in the web interface.

pagepulse.social.github=parzival-space

Sets the GitHub user name.

pagepulse.social.discord=249877580180750336

Sets the Discord user ID.

Service Specific Properties

This property stores services as an array. To add multiple services, increment the index number (0, 1, 2, etc.).

pagepulse.services[0].name=Google
pagepulse.services[0].group=Search Engines
pagepulse.services[0].endpoint=https://www.google.com/
pagepulse.services[0].interval=15
pagepulse.services[0].endpoint-hidden=false

The above example shows how to configure a service called "Google" that belongs to the "Search Engines" group, checks the endpoint "https://www.google.com/" every 15 minutes, and that shows the endpoint url in the web interface.