digital-display-garden Uses three different configuration files. They are config.properties, config.properties.deployment, and authorized.users.
These files should be made in server/. Note that those files are
in .gitignore and won't be committed. You can see example files in server/.
The server treats the first argument you pass it as a path to the configuration
file. If no arguments are passed it simply tries to read from a file called
config.properties in the current working directory. If you use ./buildAndLaunchProject.sh to launch the project, you don't need to worry, the script moves the files as needed.
authorized.users is used to designate who has administrative privilege.
Admins can change what plants are visible and view collected visitor information.
The authorized.users file looks like the following:
AUTH followed by a google-affiliated mail
ALLOW [email protected]
ALLOW [email protected]
ALLOW [email protected]
ALLOW [email protected]
config.properties and config.properties.deployment are in the Properties file format
(see this demo). You will create config.properties for when you are running in development mode, and config.properties.deployment when you are running in producton mode.
The config files have the following fields:
This is the port that the Spark server will run on: 2538
This is the Google OAuth2.0 Client ID. It is essentially a "username" for their API, but should be kept secret I believe. See GoogleAuthCredentials for how to create a client ID.
This is the Google OAuth2.0 Client Secret. This is essentially a "password" for their API, and MUST be kept secret. See GoogleAuthCredentials for how to create a client secret.
This is the URL that the server thinks visitors will be accessing
it from. It is important for this to be correct for security reasons,
and for a couple other things that assume we can create URLs for
visitors. During development on your local machine, this would be
something like http://localhost:9000, but in production, it would
look something like https://a.real.website.com. This must not
end in a slash. For example, the development publicURL for our project would be http://localhost:2538, and our production publicURL would be something like https://digital-display-garden.umn.edu.
This is the URL to which Google sends users after we have authenticated
them. During development, it should look like http://localhost:2538/callback.
During production, it should be the same domain port as publicURL, but
with /callback on the end. For example, our production mode publicURL would be https://digital-display-garden.umn.edu/callback.
This is the name of the local MongoDB database that the program uses for storing all its data.
This is the default local time zone for the server to use. This should be the time zone used by the administrators of the garden.
If a timezone is not provided, the default timezone of the machine should be used.
Here is an example of what such a config.properties file would look like:
Disclamer: The example clientID and clientSecret are randomly generated strings and are not valid. You will need to create your own from this link.
# Make sure there is no trailing white space at the end of any lines
# Server Port
serverPort=2538
# Google OAuth2.0 Client ID
clientID=VNN7GhHj8fhr5g3VLWhtQuBW9sc9FfRqUQFW8dqYkFMQ.apps.googleusercontent.com
# Google OAuth2.0 Client Secret
clientSecret=sNj2DaUEUaa_d25jrNUrwBX
# The public URL of the website
publicURL=http://localhost:9000
# The callback URL of the website
callbackURL=http://localhost:2538/callback
# The Mongo database name
databaseName=test
# Time zone for displaying dates properly (mostly admin charts)
# For valid time zones see https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html#SHORT_IDS
timezone=America/Chicago