..

0	###############################################################################
1	## Example configuration for running the Smederee hub service on localhost. ##
2	###############################################################################
3
4	hub {
5	# Configuration of the database.
6	# Defaults are given except for password and can also be overridden via
7	# environment variables.
8	database {
9	# The class name of the JDBC driver to be used.
10	driver = "org.postgresql.Driver"
11	driver = ${?SMEDEREE_HUB_DB_DRIVER}
12	# The JDBC connection URL **without** username and password.
13	url = "jdbc:postgresql://localhost/smederee"
14	url = ${?SMEDEREE_HUB_DB_URL}
15	# The username (login) needed to authenticate against the database.
16	user = "smederee_hub"
17	user = ${?SMEDEREE_HUB_DB_USER}
18	# The password needed to authenticate against the database.
19	pass = "secret"
20	pass = ${?SMEDEREE_HUB_DB_PASS}
21	}
22
23	# The general service configuration.
24	# Settings which toggle something on or off are booleans (true / false).
25	service {
26	# The hostname on which the service shall listen for requests.
27	host = "localhost"
28	# The TCP port number on which the service shall listen for requests.
29	port = 8080
30	# A directory into which files are written that are supposed to be downloaded by users (e.g. distribution
31	# files of repositories).
32	download-directory = /var/tmp/smederee/download
33	download-directory = ${?SMEDEREE_DOWNLOAD_DIR}
34
35	# Settings affecting how the service will communicate several information to
36	# the "outside world" e.g. if it runs behind a reverse proxy.
37	external {
38	# The official hostname of the service which will be used for the CSRF
39	# protection, generation of links in e-mails etc.
40	host = ${hub.service.host}
41
42	# A possible path prefix that will be prepended to any paths used in link
43	# generation. If no path prefix is used then you MUST either comment it out
44	# or set it to `path = null`!
45	#path = null
46
47	# The port number which defaults to the port the service is listening on.
48	# Please note that this is also relevant for CSRF protection!
49	# If the service is running behind a reverse proxy on a standard port e.g.
50	# 80 or 443 (http or https) then you MUST set this either to `port = null`
51	# or comment it out!
52	port = ${hub.service.port}
53
54	# The URL scheme which is used for links and will also determine if cookies
55	# will have the secure flag enabled.
56	# Valid options are:
57	# - http
58	# - https
59	scheme = "http"
60	}
61
62	# Authentication / login settings
63	authentication {
64	enabled = true
65
66	# The secret used for the cookie encryption and validation.
67	# Using the default should produce a warning message on startup.
68	cookie-secret = "CHANGEME"
69
70	# Determines after how many failed login attempts an account gets locked.
71	lock-after = 10
72
73	# Timeouts for the authentication session.
74	timeouts {
75	# The maximum allowed age an authentication session. This setting will
76	# affect the invalidation of a session on the server side.
77	# This timeout MUST be triggered regardless of session activity.
78	absolute-timeout = 3 days
79
80	# This timeout defines how long after the last activity a session will
81	# remain valid.
82	idle-timeout = 30 minutes
83
84	# The time after which a session will be renewed (a new session ID will be
85	# generated).
86	renewal-timeout = 20 minutes
87	}
88	}
89
90	# Billing / payment related settings
91	billing {
92	enabled = false
93
94	# Settings for the Stripe API used for billing.
95	stripe {
96	api-key = ${?STRIPE_API_KEY}
97	secret-key = ${?STRIPE_SECRET_KEY}
98	}
99	}
100
101	# Configuration for the darcs module for vcs related operations via darcs.
102	darcs {
103	# The directory used to store the actual repositories structured after owner.
104	# ```
105	# repositories-directory
106	# \_ user1
107	# \_ repo1
108	# \_ repo2
109	# \_ user2
110	# \_ repo1
111	# ```
112	repositories-directory = /var/tmp/smederee/darcs
113	repositories-directory = ${?SMEDEREE_DARCS_REPOS_DIR}
114	# The path to the darcs binary executable. If not a full path (i.e. just
115	# `darcs`) it must be present on the `$PATH` of the environment under which
116	# the server is running.
117	executable = "darcs"
118	executable = ${?SMEDEREE_DARCS_EXECUTABLE}
119	}
120
121	# The email middleware configuration for sending email messages.
122	email {
123	# The hostname of the email server (SMTP) to connect to.
124	host = "localhost"
125	host = ${?EMAIL_HOST}
126	# The port number to be used for the connection.
127	# This is usually 25 for local sendmail connections and 465 for SMTPS or 587 SMTP_TLS connections.
128	port = 25
129	port = ${?EMAIL_PORT}
130	# Specify the transport method (security) to be used for the connection (should either be SMTPS or TLS).
131	transport = "PLAIN"
132	transport = ${?EMAIL_TRANSPORT}
133	# An optional username if authentication is required.
134	username = ${?EMAIL_USERNAME}
135	# An optional password if authentication is required.
136	password = ${?EMAIL_PASSWORD}
137	}
138
139	# SSH server component settings
140	ssh {
141	enabled = true
142	# A username for generic access to services for darcs clone, pull and push
143	# (e.g. `darcs pull genericUser@smederee-domain:accountName/repository`).
144	generic-user = "darcs"
145	# The hostname/address the SSH server will bind to.
146	host = "localhost"
147	host = ${?SSH_SERVER_HOST}
148	# The port number on which the SSH server will listen.
149	port = 30983
150	port = ${?SSH_SERVER_PORT}
151	# A path to the file from which the server key is loaded and also written to if it needs to be generated.
152	# This file should only be accessible for the user account that runs the smederee service.
153	server-key-file = /var/tmp/smederee/server.key
154	server-key-file = ${?SSH_SERVER_KEY}
155	}
156
157	# Signup / registration related settings.
158	signup {
159	enabled = true
160	}
161
162	# Configuration regarding the integration with the ticket service.
163	ticket-integration {
164	enabled = true
165	# The base URI used to build links to the ticket service.
166	base-uri = "http://localhost:8080"
167	base-uri = ${?SMEDEREE_TICKET_BASE_URI}
168	}
169	}
170	}
171
172	tickets {
173	# Configuration of the database.
174	# Defaults are given except for password and can also be overridden via
175	# environment variables.
176	database {
177	# The class name of the JDBC driver to be used.
178	driver = "org.postgresql.Driver"
179	driver = ${?SMEDEREE_TICKETS_DB_DRIVER}
180	# The JDBC connection URL **without** username and password.
181	url = "jdbc:postgresql://localhost/smederee"
182	url = ${?SMEDEREE_TICKETS_DB_URL}
183	# The username (login) needed to authenticate against the database.
184	user = "smederee_tickets"
185	user = ${?SMEDEREE_TICKETS_DB_USER}
186	# The password needed to authenticate against the database.
187	pass = "secret"
188	pass = ${?SMEDEREE_TICKETS_DB_PASS}
189	}
190
191	# Settings affecting how the service will communicate several information to
192	# the "outside world" e.g. if it runs behind a reverse proxy.
193	external = ${hub.service.external}
194
195	# Configuration regarding the integration with the hub service.
196	hub-integration {
197	# The base URI used to build links to the hub service.
198	base-uri = "http://localhost:8080"
199	base-uri = ${?SMEDEREE_HUB_BASE_URI}
200	}
201	}