forked from DMPRoadmap/roadmap
-
Notifications
You must be signed in to change notification settings - Fork 13
/
dmproadmap.yml
437 lines (364 loc) · 17.4 KB
/
dmproadmap.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
default: &default
# Note that we use the AnywayConfig gem to manage our configuration variables. AnywayConfig loads
# your config in a cascading manner similar to the way CSS works. The load order is:
# - dmproadmap.yml (this file)
# - secrets.yml
# - credentials.yml.enc
# - AWS SSM variables (if running on an AWS EC2 instance)
# - ENV variables (from either the .env file or ENV variables)
#
# If a variable is defined in the dmproadmap.yml and also in the credentials.yml.enc, the value
# in the credentials file will be used.
#
# For more info about AnywayConfig, see: https://github.com/palkan/anyway_config
#
# Blank entries in this file are by design. AnywayConfig allows us to specify required config
# variables. If for example database_password is not found in one of the locations mentioned above,
# then the application will fail to startup.
# For example:
# "Anyway::Config::ValidationError: The following config parameters are missing or empty: database_password
#
# If you are not on an AWS EC2 environment and/or do not have access to SSM then you will see the
# following warnings. They can be ignored.
# "UC3 SSM Error: SSM parameter name is not fully qualified and no ssm_root_path defined."
#
# We have added a lib/tasks/utils/config.rake task file which can be used to help debug any config
# issues. For example you can run `rails config:trace` which will return something like this (note:
# ':secrets' is the Rails credentials file, :env is either an ENV of .env variable):
#
# "Loading DmproadmapConfig:"
# "---------------------------------------------------"
#
# {"database_password"=>
# {:value=> "blah...blah...blah",
# :source=>{:type=>:credentials, :store=>"config/credentials.yml.enc"}},
# "server_host"=>
# {:value=>"example.org",
# :source=>{:type=>:ssm_parameter_store, :ssm_root_path=>"/my/path/env:/my/path/app/default"}},
# "port"=>
# {:value=>"3000", :source=>{:type=>:yml, :path=>"config/dmproadmap.yml"}}}
#
# In Summary:
# If an entry here is blank then you MUST define it in the credentials.yml.enc (preferred) or in an
# ENV variable (`DMPROADMAP_VARIABLE_NAME`)
#
# If you would like to override one of the other values in this file then you should define it as
# an ENV variable (`DMPROADMAP_VARIABLE_NAME`)
# ============================
# = Base Rails configuration =
# ============================
# See https://guides.rubyonrails.org/v5.0/configuring.html
server_host: "localhost"
port: "3000"
web_concurrency: 2
cookie_key: "_my_application_session"
rails_log_to_stdout: true
rails_max_threads: 5
rails_serve_static_files: true
# Determines how long to cache results for OrgSelection::SearchService
cache_org_selection_expiration: "86_400"
# Determines how long to cache results for the ResearchProjectsController
cache_research_projects_expiration: "86_400"
# ==========================
# = Database configuration =
# ==========================
# See https://guides.rubyonrails.org/v5.0/configuring.html#configuring-a-database
database_adapter: "mysql2"
database_name: "my_app"
database_host: "localhost"
database_pool_size: 16
database_username: "root"
database_password:
# =========================
# = Locales configuration =
# =========================
locales_default: "en-US"
locales_i18n_join_character: "-"
locales_gettext_join_character: "_"
# ===================================
# = Security configuration (Devise) =
# ===================================
# Security configuration used by the Devise gem to encrypt/decrypt passwords
# See https://github.com/heartcombo/devise
# add your unique value by running `rails secret` and pasting the response here"
devise_pepper:
# ==========================================
# = Image upload configuration (Dragonfly) =
# ==========================================
# Org logo store configuration.
# See https://github.com/markevans/dragonfly
dragonfly_aws: false
dragonfly_bucket: ""
dragonfly_host: ""
dragonfly_root_path: "logos"
dragonfly_secret: ""
dragonfly_region: "us-west-2"
dragonfly_url_scheme: "s3"
# ======================================
# = External Api service configuration =
# ======================================
# DataCite (populate if you're using them as your DOI registrar)
datacite_active: false
datacite_shoulder: "10.1234"
datacite_api_base_url: "https://api.test.datacite.org/"
datacite_landing_page_url: "https://doi.org/"
# You should also check the config/initializers/external_apis/datacite.rb config
# DMPHub is a DMP metadata repository that will mint DMP IDs and provide a landing page for them.
# See https://github.com/CDLUC3/dmphub
dmphub_active: true
dmphub_url: "http://localhost:3001/api/v0/"
dmphub_landing_page_url: "http://localhost:3001/dmps/doi:"
# You should also check the config/initializers/external_apis/dmphub.rb config
# Google Analytics config. Tracker root is the base key for your application
# NOTE: This value must match the :name of the application you define below
google_analytics_tracker_root: "MyApp"
# The OpenAire API is used to retrieve grant ids on the Project Details page
openaire_active: false
# The re3data API is used to retrieve repositories for selection on the Research Outputs page
re3data_active: true
# The SPDX License API is used to license information for selection on the Research Outputs page
spdx_active: true
# ORCID provides identifiers for people.
# See the public api docs https://info.orcid.org/documentation/features/public-api/
# Or the member api docs https://info.orcid.org/documentation/features/member-api/
orcid_sandbox: true
orcid_api_base_url: "https://api.sandbox.orcid.org/v3.0/"
orcid_landing_page_url: "https://sandbox.orcid.org/"
orcid_client_id: "12345"
orcid_client_secret: "98765"
# Recaptcha is used to prevent malicious use of the Contact Us and Create Account forms
# See https://developers.google.com/recaptcha/intro
recaptcha_enabled: false
# Rollbar converts errors into GutHub issues
# See https://docs.rollbar.com/docs/gem-configuration-reference
# If you have a Rollbar account uncomment these lines and add your access_token
# rollbar_env: production
# rollbar_access_token:
# Will use the ROR api to search for Org's as the user types
ror_active: false
# Whether or not to restrict Org selection to the ones in the `orgs` table (Meaning not allowing
# users to search/select from the org_indices table)
restrict_orgs: false
# Translation IO can be used to help failitate translating your custom code.Translations for the
# core DMPRoadmap codebase are handled by the development team (DEV only)
# See https://translation.io/rails/usage
translation_io_key:
# Usersnap is a service that allows users to provide feedback on specific portions of the UI.
# We do not recommend using this in production! (Not used in PROD)
# See https://usersnap.com/
usersnap_key:
# ============================
# = Shibboleth configuration =
# ============================
# Enable shibboleth as an alternative authentication method
# Requires server configuration and omniauth shibboleth provider configuration
# See config/initializers/devise.rb
shibboleth_enabled: true
# Relative paths to Shibboleth SSO
shibboleth_login_url: "/Shibboleth.sso/Login"
shibboleth_logout_url: "/Shibboleth.sso/Logout?return="
# If this value is set to true your users will be presented with a list of orgs that have a
# shibboleth identifier in the orgs_identifiers table. If it is set to false (default), the user
# will be driven out to your federation's discovery service
#
# A super admin will also be able to associate orgs with their shibboleth entityIds if this is
# set to true
shibboleth_use_filtered_discovery_service: false
# ===================
# = Sign in options =
# ===================
# The order in which to display the sign in options (e.g. Shib first, then email + password)
sign_in_options:
- "shared/authentication/shib_sign_in_form"
- "shared/authentication/sign_in_form"
# =============================================
# = PDF generator configuration (wkhtmltoprf) =
# =============================================
# Location of the wkhtmltopdf executable.
wkhtmltopdf_path: <%= Rails.root.join("bin", "wkhtmltopdf").to_s %>
# ==================================
# = Base application configuration =
# ==================================
# This name is used throughout the system to identify your application. (e.g. in
# email communications, API calls to external systems, etc.)
# NOTE - This name must match the Google Analytics Tracker in this file!
name: "MyApp"
# The :from email address used in emails sent by the application
do_not_reply_email: "do-not-reply-my-app-dev@cdlib.org"
# The helpdesk email
helpdesk_email: "help@example.org"
# Used as the default domain when 'archiving' (aka anonymizing) a user account
# for example `jane.doe@uni.edu` becomes `1234@removed_accounts-example.org`
archived_accounts_email_suffix: "@removed_accounts_dmproadmap.org"
# Available CSV separators, the default is ','
csv_separators: [",", "|", "#"]
# Determines the number of links a funder is allowed to add to their template
max_number_links_funder: 5
# Maximum number of links to display for an Org
max_number_links_org: 3
# Determines the number of links a funder can add for sample plans for their template
max_number_links_sample_plan: 5
# Determines the maximum number of themes to display per column when an org admin
# updates a template question or guidance
max_number_themes_per_column: 5
# default results per page
results_per_page: 10
# =================================
# = Contact us page configuration =
# =================================
# Uncomment the following line if you want to redirect your users to an
# organisational contact/help page instead of using the built-in contact_us form
# contact_us_url: "https//example.org/default_contact_us_page"
# Your organisation name, used in various places throught the application
organisation_name: "My institution's name"
# Your orgsanisation abbreviation
organisation_abbreviation: "DMPTool"
# Your organisation's homepage, used in some of the public facing pages
organisation_url: "https://example.org/"
# Your organisation's legal (official) name - used in the copyright portion of the footer
organisation_copywrite_name: "My institution's official name"
# Your organisation's helpdesk email
email_from_address: "my.organization@email.edu"
# Your organisation's telephone number - used on the contact us page. This can be left blank.
organisation_phone: "My institution's phone number"
# Your organisation's address - used on the contact us page
organisation_address_line1: "My institution"
organisation_address_line2: "Department"
organisation_address_line3: "Address"
organisation_address_line4: "City, State and postal code"
organisation_country: "ZZZ"
# The Google maps link to your organisation's location - used to display the
# Google map on the contact us page.
# To find your organisation's Google maps URL, open maps.google.com, search for
# your orgnaisation and then click the menu link to the left of the search box,
# once the menu opens, click the 'share or embed' link and the 'embed' tab on
# the dialog window that opens. DO NOT place the entire <iframe> tag below, just
# the address!
organisation_google_maps_link:
# =====================
# = API configuration =
# =====================
# The largest page size allowed in requests to the API (all versions)
api_max_page_size: 100
# The link to the API documentation - used in emails about the API.
api_documentation_urls:
v0: "https://github.com/CDLUC3/dmptool/wiki/api-v0-documentation"
v1: "https://github.com/CDLUC3/dmptool/wiki/api-v1-documentation"
v2: "https://github.com/CDLUC3/dmptool/wiki/api-v2-documentation"
# The current landing page for API documentation
api_documentation_overview_url: "https://github.com/CDLUC3/dmptool/wiki/API-Overview"
# =============================
# = Static page configuration =
# =============================
# The link to your release notes
release_notes_url: "https://github.com/CDLUC3/dmptool/releases"
# The link to your issues list
issue_list_url: "https://github.com/CDLUC3/dmptool/issues"
# The link to your Listserv
user_group_subscription_url: ""
# The link to your blog
blog_rss: "https://example.org/feed"
# The links that appear on the home page. Add any number of links
welcome_links: []
# =================
# = Plan defaults =
# =================
# The default visibility a plan receives when it is created.
# options: 'privately_visible', 'organisationally_visible' and 'publicly_visibile'
plans_default_visibility: "privately_visible"
# The percentage of answers that have been filled out that determine if a plan
# will be marked as complete. Plan completion has implications on whether or
# not plan visibility settings are editable by the user and whether or not the
# plan can be submitted for feedback
plans_default_percentage_answered: 50
# Whether or not Super adminis can read all of the user's plans regardless of
# the plans visibility and whether or not the plan has been shared
plans_org_admins_read_all: true
# Whether or not Organisational administrators can read all of the user's plans
# regardless of the plans visibility and whether or not the plan has been shared
plans_super_admins_read_all: true
# Whether or not to display they Plan Overview tab to users when they're editing
# their DMP
show_overview_tab: false
# Whether the collaborators section of the DMP (people who co-owner, can edit or comment)
# are displayed on the 'Share' tab.
# If true: The 'Share' tab appears with Plan Visibility and Collaborators
# If false: It appears on the Contributors tab and the 'Share' tab becomes 'Publish'
show_collaborators_on_share_tab: false
# Whether or not the coversheet checkbox should be checked by default
download_coversheet_tickbox_checked: false
# ======================================= #
# = maDMP / Networked DMP functionality = #
# ======================================= #
# Whether or not to require contributor names and/or emails.
# Note that at least one is required!
require_contributor_email: false
require_contributor_name: true
# Enable/disable functionality on the Project Details tab
enable_ethical_issues: true
enable_research_domain: true
# This flag will enable/disable the entire Research Outputs tab. The others below will
# just enable/disable specific functionality on the Research Outputs tab
enable_research_outputs: true
enable_license_selection: true
enable_metadata_standard_selection: true
enable_repository_selection: true
# The following flags will allow the system to include the question and answer in the JSON output
# - questions with a theme equal to 'Preservation'
extract_preservation_statements_from_themed_questions: false
# - questions with a theme equal to 'Data Collection'
extract_data_quality_statements_from_themed_questions: false
# - questions with a theme equal to 'Ethics & privacy' or 'Storage & security'
extract_security_privacy_statements_from_themed_questions: false
# Specify a list of the preferred licenses types. These licenses will appear in a select
# box on the 'Research Outputs' tab when editing a plan along with the option to select
# 'other'. When 'other' is selected, the user is presented with the full list of licenses.
#
# The licenses will appear in the order you specify here.
#
# Note that the values you enter must match the :identifier field of the licenses table.
# You can use the `%{latest}` markup in place of version numbers if desired.
preferred_licenses:
- "CC-BY-%{latest}"
- "CC-BY-SA-%{latest}"
- "CC-BY-NC-%{latest}"
- "CC-BY-NC-SA-%{latest}"
- "CC-BY-ND-%{latest}"
- "CC-BY-NC-ND-%{latest}"
- "CC0-%{latest}"
# Link to external guidance about selecting one of the preferred licenses. A default
# URL will be displayed if none is provided here. See app/views/research_outputs/licenses/_form
preferred_licenses_guidance_url: "https://creativecommons.org/about/cclicenses/"
# Whether or not to allow users to manually add related_identifiers to a plan
enable_related_identifiers: true
# Whether or not to allow the system to fetch citations for RelatedIdentifiers
enable_citation_lookup: true
# Allow DMP ID minting
enable_dmp_id_registration: true
# Allow DMP IDs to be published to the user's ORCID record
enable_orcid_publication: true
# ============================
# = User preference defaults =
# ============================
# The default user email preferences used when a new account is created
preferences:
email:
users:
new_comment: false
admin_privileges: true
added_as_coowner: true
feedback_requested: true
feedback_provided: true
owners_and_coowners:
visibility_changed: true
development:
<<: *default
# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
<<: *default
stage:
<<: *default
production:
<<: *default