Configuration
Configuring Resiste is not that difficult. This page documents everything you need to do.
Java
Resiste requires Java 11. The Windows and Linux downloads come embedded with a Java 11, so Resiste does not depend on the system-level Java installation to run.
However, if you want to override the Java version that comes embedded
with Resiste, you can do so by editing, in the [RESISTE_HOME]/bin/
directory, the start-resiste.sh and start-resiste.bat
files.
Logging
See the Logging page for more information about configuring logging.
How to Send Email (SMTP Account)
Resiste needs the SMTP information for your email provider. Each email provider is different so how you get this information is up to you.
In the [RESISTE_HOME]/conf/ directory, make a copy
of email(example).properties as email.properties.
Edit email.properties, adding your SMTP account
details.
# # This file holds the information needed to access your email account. # you should rename this file "email.properties" in order to get # Resiste to find it. If the "email.properties" file is not found when # Resiste starts, the application will print an error message and exit. # # @SINCE 1.0.0.0 # Value is either "true" or "false: # If "true" an SSL connection is used to connect to the SMTP server # If "false" an UN-ENCRYPTED connection is used to connect to the SMTP server # # @SINCE 1.1.9.0 # Value is either "true" or "false: # If "true" an SSL connection is used to connect to the SMTP server # If "false" a TLS connection is used to connect to the SMTP server. # sslEnabled=true || false # This is the name of the SMTP host machine. host=smtp.somewhere.org # This is the port number of the SMTP host machine. # The same host may support both SSL and TLS but on # different ports. So make sure your port number here # matches with the 'sslEnabled' configuration above. port=44 # This is what you use in the “username” field when # you login. Typically this is the same as your email # address, but this isn't always the case. username=account # This is what you use in the “password” field when # you login. This value is CLEAR TEXT, so keep this # properties file safe. password=password # This is the email address you want for the # email's FROM field. Enter the value using # the format shown below. Typically this is # the email address for the account. # WARNING: If you make this an email address other # than the one for the account, the email may # be immediately flagged as SPAM. emailAddress=FIRSTNAME LASTNAME <ADDRESS@EMAIL.COM> # This is the email address you want for the # email's TO field. Enter the value using # the format shown below. For testing, it's a good # idea to send it to yourself first. sendToAddress=FIRSTNAME LASTNAME <ADDRESS@EMAIL.COM>
RSS URLs to Watch
Resiste will watch any RSS URL you configure.
In the [RESISTE_HOME]/conf/ directory, add your
RSS URLs to rss_urls.csv.
This is a simple comma-separated data file. Here is an example:
# Example #1 # Get all of the RSS entries for xkcd # 0e088fc2-4cff-45af-a49f-ff96091cd476,https://xkcd.com/rss.xml # Example #2 # Get RSS entries for christiantoday.com matching the regular expression: # (forgiveness|miracles?) # This will find entries only with the words forgiveness, miracle, or miracles. 2890a6c2-bb26-4a13-9b4a-0bd73dd2ef90,https://www.christiantoday.com/rss/feed,regex[[(forgiveness|miracles?)]]
Each line has 2 required fields and 1 optional field
- ID
- URL
- REGEX
ID. REQUIRED. Can be any value you want, as long as it is unique. I suggest using an Online UUID Generator Tool to generate unique values. But they can also be as simple as 1,2,3,4.
URL. REQUIRED. Is the URL of the RSS feed you want to keep track of. Typically, all you need to do is copy the link from your browser and paste it in.
REGEX. OPTIONAL. A regular expression used to match RSS
entries. RESISTE matches the regular expression against the
entry title and the entry contents. If either the
title or the contents match the regular expression, the
entry will be emailed to you. Otherwise, the entry will not be
emailed to you.
Use https://regex101.com/ to
test your regular expression. Once you have it right, paste it
into rss_urls.csv, surrounding the regular expression
with regex[[]]. Here is an example. This regular
expression will match an entry that has any of these three words
(1) forgiveness, (2) miracle, (3) miracles.
regex[[(forgiveness|miracles?)]]
RSS Email
Configure RSS email subject by editing, in the [RESISTE_HOME]/conf/
directory, the rss_email_subject.ftlt.
Configure RSS email body by editing, in the [RESISTE_HOME]/conf/
directory, the rss_email_body.ftlt.
Error Email
Configure error email subject by editing, in the [RESISTE_HOME]/conf/
directory, the error_email_subject.ftlt.
Configure error email body by editing, in the [RESISTE_HOME]/conf/
directory, the error_email_body.ftlt.
Database location
By default, Resiste will use a built-in Derby database to store
the RSS history. The built-in Derby database is located in
[RESISTE_HOME]/data/resiste
Resiste only supports a Derby database at this time. In general, you never need to mess with the built-in database.
However, if you want to move the Derby database to a different
location on your local file system or if you want to use a
remote Derby server, you can configure this.
In the [RESISTE_HOME]/conf/ directory, configure the
connection to the Derby database by updating db.properties.
Here are a couple examples.
NOTE: See security for information on encrypting the username and password.
LOCAL FILE SYSTEM Example
url=jdbc:derby:C:/Users/Mike/Documents/Databases/Derby/Ferris/resiste username=resiste_standalone password=x4A03HZ7ZV*lzB% schema=APP
REMOTE SERVER Example
url=jdbc:derby://myderbyserver:1527/resiste username=resiste_standalone password=x4A03HZ7ZV*lzB% schema=APP
Configuration complete! Next is security.