diaspora.yml.example 24.8 KB
Newer Older
Jonne Haß's avatar
Jonne Haß committed
1 2
## Some notes about this file:
## - All comments start with a double #
3
## - All settings are commented out with a single #
4 5
##   To change the default settings, you need both to uncomment the lines
##   AND, in most cases, to change the value that is given.
6 7 8 9 10
## - Take care to keep proper indentation, that is by simply deleting
##   the original #, with no additional space before the setting's name.
## - Take care to keep proper quoting. All ' must have a matching ' at
##   the end of the same line. The same goes for "
## - Lines containing "## Section" are section headings. Do not edit them!
Jonne Haß's avatar
Jonne Haß committed
11
## - Lists need the space after the -
12 13
## - The values true, false and numbers should have no quote marks.
##   Single words don't need quote marks, but it doesn't do any harm to have them.
Jonne Haß's avatar
Jonne Haß committed
14
##
15
## You can set and/or override all these settings through environment variables
Jonne Haß's avatar
Jonne Haß committed
16 17 18 19
## with the following conversion rules:
## - Strip the top level namespace (configuration, production, etc.)
## - Build the path to the setting, for example environment.s3.enable
## - Replace the dots with underscores: environment_s3_enable
20 21
## - Convert to upper case: ENVIRONMENT_S3_ENABLE
## - Specify lists/arrays as comma-separated values
22 23
##
## - For example, on Heroku:
24
##   heroku config:set SERVICES_FACEBOOK_APP_ID=yourappid SERVICES_FACEBOOK_SECRET=yourappsecret
Jonne Haß's avatar
Jonne Haß committed
25

26
configuration: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
27

28
  ## You need to change or at least review the settings in this section
29
  ## in order for your pod to work.
30
  environment: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
31

Jonne Haß's avatar
Jonne Haß committed
32 33
    ## Set the hostname of the machine you're running Diaspora on, as seen
    ## from the internet. This should be the URL you want to use to
34 35
    ## access the pod. So if you plan to use a reverse proxy, it should be
    ## the URL the proxy listens on. DO NOT CHANGE THIS AFTER INITIAL SETUP!
Jonne Haß's avatar
Jonne Haß committed
36
    ## However changing http to https is okay and has no consequences.
37 38
    ## If you do change the URL, you will have to start again as the URL
    ## will be hardcoded into the database.
Jonne Haß's avatar
Jonne Haß committed
39
    #url: "https://example.org/"
Dennis Schubert's avatar
Dennis Schubert committed
40

41 42 43 44
    ## Set the bundle of certificate authorities (CA) certificates.
    ## This is specific to your operating system.
    ## Examples (uncomment the relevant one or add your own):
    ## For Debian, Ubuntu, Archlinux, Gentoo (package ca-certificates):
Jonne Haß's avatar
Jonne Haß committed
45
    #certificate_authorities: '/etc/ssl/certs/ca-certificates.crt'
46
    ## For CentOS, Fedora:
Jonne Haß's avatar
Jonne Haß committed
47
    #certificate_authorities: '/etc/pki/tls/certs/ca-bundle.crt'
Dennis Schubert's avatar
Dennis Schubert committed
48

49
    ## URL for a remote Redis (default=localhost).
50 51
    ## Don't forget to restrict IP access if you uncomment these!
    #redis: 'redis://example_host'
Jonne Haß's avatar
Jonne Haß committed
52 53
    #redis: 'redis://username:password@host:6379/0'
    #redis: 'unix:///tmp/redis.sock'
Dennis Schubert's avatar
Dennis Schubert committed
54

55 56 57 58 59 60
    ## Require SSL (default=true).
    ## When set, your pod will force the use of HTTPS in production mode.
    ## Since OAuth2 requires SSL, Diaspora's future API might not work if
    ## you're not using SSL. Also there is no guarantee that posting to
    ## services will be possible if SSL is disabled.
    ## Do not change this default unless you are sure!
61
    #require_ssl: true
Dennis Schubert's avatar
Dennis Schubert committed
62

63 64 65 66 67 68
    ## Single-process mode (default=false).
    ## If set to true, Diaspora will work with just the appserver (Unicorn by
    ## default) running. However, this makes it quite slow as intensive jobs
    ## must be run all the time inside the request cycle. We strongly
    ## recommended you leave this disabled for production setups.
    ## Set to true to enable.
69
    #single_process_mode: false
Jonne Haß's avatar
Jonne Haß committed
70 71 72 73

    ## Sidekiq - background processing
    sidekiq: ## Section

74 75 76 77 78 79
      ## Number of parallel threads Sidekiq uses (default=5).
      ## If you touch this, please set the pool setting in your database.yml
      ## to a value that's at minimum close to this! You can safely increase
      ## it to 25 and more on a medium-sized pod. This applies per started
      ## Sidekiq worker, so if you set it to 25 and start two workers, you'll
      ## process up to 50 jobs in parallel.
80
      #concurrency: 5
81

82
      ## Number of times a job is retried (default=10).
83 84 85 86
      ## There's an exponential effect to this: if you set this too high you
      ## might get too many jobs building up in the queue.
      ## Set it to false to disable it completely.
      #retry: 10
Jonne Haß's avatar
Jonne Haß committed
87

88 89
      ## Namespace to use in Redis. Useful if you need to run
      ## multiple instances of Diaspora using the same Redis instance.
Jonne Haß's avatar
Jonne Haß committed
90 91
      #namespace: "diaspora"

92
      ## Lines of backtrace that are stored on failure (default=15).
93 94
      ## Set n to the required value. Set this to false to reduce memory
      ## usage (and log size) if you're not interested in this data.
95
      #backtrace: 15
Jonne Haß's avatar
Jonne Haß committed
96

97
      ## Log file for Sidekiq (default="log/sidekiq.log")
98
      #log: "log/sidekiq.log"
Dennis Schubert's avatar
Dennis Schubert committed
99

Jonne Haß's avatar
Jonne Haß committed
100
    ## Use Amazon S3 instead of your local filesystem
101
    ## to handle uploaded pictures (disabled by default).
102
    s3: ## Section
103

Jonne Haß's avatar
Jonne Haß committed
104
      #enable: true
105 106
      #key: 'change_me'
      #secret: 'change_me'
Jonne Haß's avatar
Jonne Haß committed
107 108
      #bucket: 'my_photos'
      #region: 'us-east-1'
109

110
      ## Use max-age header on Amazon S3 resources (default=true).
111
      ## When true, this allows locally cached images to be served for up to
112 113 114
      ## one year. This can improve load speed and save requests to the image
      ## host. Set to false to revert to browser defaults (usually less than
      ## one year).
115
      #cache : true
Dennis Schubert's avatar
Dennis Schubert committed
116

117
    ## Set redirect URL for an external image host (Amazon S3 or other).
118 119 120
    ## If hosting images for your pod on an external server (even your own),
    ## add its URL here. All requests made to images under /uploads/images
    ## will be redirected to https://yourhost.tld/uploads/images/
Jonne Haß's avatar
Jonne Haß committed
121
    #image_redirect_url: 'https://images.example.org'
Dennis Schubert's avatar
Dennis Schubert committed
122

123
    assets: ## Section
124

125
      ## Serve static assets via the appserver (default=false).
126 127
      ## This is highly discouraged for production use. Let your reverse
      ## proxy/webserver do it by serving the files under public/ directly.
128
      #serve: false
Dennis Schubert's avatar
Dennis Schubert committed
129

130
      ## Upload your assets to S3 (default=false).
131
      #upload: false
Dennis Schubert's avatar
Dennis Schubert committed
132

Jonne Haß's avatar
Jonne Haß committed
133 134
      ## Specify an asset host. Ensure it does not have a trailing slash (/).
      #host: http://cdn.example.org/diaspora
135

136
    ## Pubsub server (default='https://pubsubhubbub.appspot.com/').
137 138
    ## Diaspora is only tested against the default pubsub server.
    ## You probably don't want to uncomment or change this.
139
    #pubsub_server: 'https://pubsubhubbub.appspot.com/'
Dennis Schubert's avatar
Dennis Schubert committed
140

141 142 143 144 145 146 147 148 149 150 151
    ## Logger configuration
    logging: ## Section

      logrotate: ## Section

        ## Roll the application log on a daily basis (default=true).
        #enable: true

        ## The number of days to keep (default=7)
        #days: 7

152
  ## Settings affecting how ./script/server behaves.
153
  server: ## Section
154
    ## Where the appserver should listen to (default=unix:tmp/diaspora.sock)
155 156
    #listen: 'unix:tmp/diaspora.sock'
    #listen: 'unix:/run/diaspora/diaspora.sock'
157
    #listen: '127.0.0.1:3000'
158

159
    ## Rails environment (default='development').
160
    ## The environment in which the server should be started by default.
161
    ## Change this to 'production' if you wish to run a production environment.
162
    #rails_environment: 'development'
Dennis Schubert's avatar
Dennis Schubert committed
163

164
    ## Write unicorn stderr and stdout log.
165 166
    #stderr_log: '/usr/local/app/diaspora/log/unicorn-stderr.log'
    #stdout_log: '/usr/local/app/diaspora/log/unicorn-stdout.log'
Dennis Schubert's avatar
Dennis Schubert committed
167

168
    ## Number of Unicorn worker processes (default=2).
169 170
    ## Increase this if you have many users.
    #unicorn_worker: 2
171

172
    ## Number of seconds before a request is aborted (default=90).
173
    ## Increase if you get empty responses, or if large image uploads fail.
174
    ## Decrease if you're under heavy load and don't care if some
175 176
    ## requests fail.
    #unicorn_timeout: 90
Dennis Schubert's avatar
Dennis Schubert committed
177

178
    ## Embed a Sidekiq worker inside the unicorn process (default=false).
179
    ## Useful for minimal Heroku setups.
180
    #embed_sidekiq_worker: false
Jonne Haß's avatar
Jonne Haß committed
181

182
    ## Number of Sidekiq worker processes (default=1).
183
    ## In most cases it is better to
184
    ## increase environment.sidekiq.concurrency instead!
185
    #sidekiq_workers: 1
Dennis Schubert's avatar
Dennis Schubert committed
186

187 188 189
  ## Diaspora has an internal XMPP server. If you want to enable the chat
  ## functionality or want to use a custom XMPP server, then you should edit
  ## the following configuration.
190
  ##
191
  ## The internal XMPP server does not support https
192 193 194 195 196 197 198 199 200 201
  ## and even if we implement it, we would ran into certificate issues.
  ## The problem with mixed-content is described here:
  ## https://github.com/Zauberstuhl/diaspora/issues/6
  ##
  ## The easiest way of avoiding certificate and mixed-content issues
  ## is to use a proxy, e.g.:
  ##
  ## Apache: https://gist.github.com/Zauberstuhl/2d09330961614b12b642
  ## Nginx: https://gist.github.com/Zauberstuhl/ee95e1eacefa6ddbec6e
  ##
202 203
  ## If you configured your proxy correctly, you should adjust
  ## the configuration in the BOSH section.
204 205
  chat: ## Section

206
    ## Enable the chat service and all its components.
207
    #enabled: true
208 209

    ## Custom XMPP server configuration goes here.
210 211
    server: ## Section

212 213
      ## Start built-in XMPP server (default=true).
      ## In case you want to run your own server, you should disable it.
214
      #enabled: false
215 216 217

      ## Set the directory in which to look for virtual hosts'
      ## TLS certificates.
218
      #certs: 'config/vines'
219 220 221 222 223

      ## The server accepts by default only valid certificates.
      ## Any connection which uses self-signed ones will be closed.
      ## If you'd like to accept self-signed certificates
      ## on your server, set the next option to true.
224
      #accept_self_signed: true
225 226 227

      ## Only edit the next option if you'd like to deny
      ## your users to exchange messages between other XMPP servers.
228
      #cross_domain_messages: false
229 230 231 232

      ## Set the maximum of offline messages stored per user (default=150).
      ## If it exceeds, it will start deleting old messages. You can disable
      ## offline message support completely by setting the option to zero.
233
      #max_offline_msgs: 150
234 235

      ## Client to server
236 237
      c2s: ## Section

238
        ## Configure the address that vines should listen on.
239
        #address: '0.0.0.0'
240 241

        ## Configure the client-to-server port.
242
        #port: 5222
243 244

        ## The maximum we'd like to allow for stanza size.
245
        #max_stanza_size: 65536
246 247 248

        ## The max_resources_per_account attribute, limits how many
        ## concurrent connections one user can have to the server.
249 250
        #max_resources_per_account: 5

251
      ## Server to server
252 253
      s2s: ## Section

254
        ## Configure the address that vines should listen on.
255
        #address: '0.0.0.0'
256 257

        ## Configure the server-to-server port.
258
        #port: 5269
259 260 261

        ## The max_stanza_size attribute should be
        ## much larger than the setting for client-to-server.
262
        #max_stanza_size: 131072
263 264 265 266

        ## By default every XMPP server with a valid certificate
        ## is able to communicate with your server. In case of a
        ## malicious server (e.g. spam reason), you can black-list them.
267 268 269 270
        #blacklist:
        #  - 'example.com'
        #  - 'malicous.net'

271
      ## XEP-0124 BOSH requests
272 273
      bosh: ## Section

274 275 276
        ## If you'd like to use a proxy, you should set the proxy
        ## option to true, otherwise jsxc always tries to
        ## connect directly to the port specified below.
277
        #proxy: true
278 279

        ## Configure the address that vines should listen on.
280
        #address: '0.0.0.0'
281 282

        ## Configure the BOSH port.
283
        #port: 5280
284 285

        ## Configure the bind endpoint.
286
        #bind: '/http-bind'
287 288

        ## The maximum we'd like to allow for stanza size.
289
        #max_stanza_size: 65536
290 291 292

        ## The max_resources_per_account attribute, limits how many
        ## concurrent connections one user can have to the server.
293 294
        #max_resources_per_account: 5

295
      ## Specify log behaviour here.
296
      log: ## Section
297 298

        ## Log file location.
299
        #file: 'log/vines.log'
300 301 302

        ## Set the logging level to debug, info, warn, error, or fatal.
        ## The debug level logs all XML sent and received by the server.
303 304
        #level: 'info'

305
  ## Settings potentially affecting the privacy of your users.
306
  privacy: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
307

308
    ## Include jQuery from jquery.com's CDN (default=false).
309 310 311 312
    ## Enabling this can reduce traffic and speed up load time since most
    ## clients already have this one cached. When set to false (the default),
    ## the jQuery library will be loaded from your pod's own resources.
    #jquery_cdn: false
Dennis Schubert's avatar
Dennis Schubert committed
313

314 315
    ## Google Analytics (disabled by default).
    ## Provide a key to enable tracking by Google Analytics.
Jonne Haß's avatar
Jonne Haß committed
316
    #google_analytics_key:
Dennis Schubert's avatar
Dennis Schubert committed
317

318
    ## Piwik Tracking (disabled by default).
Jonne Haß's avatar
Jonne Haß committed
319 320
    ## Provide a site ID and the host piwik is running on to enable
    ## tracking through Piwik.
321
    piwik: ## Section
322

Jonne Haß's avatar
Jonne Haß committed
323 324 325
      #enable: true
      #host: 'stats.example.org'
      #site_id: 1
Dennis Schubert's avatar
Dennis Schubert committed
326

327
    ## Mixpanel event tracking (disabled by default).
Jonne Haß's avatar
Jonne Haß committed
328
    #mixpanel_uid:
Dennis Schubert's avatar
Dennis Schubert committed
329

330
    ## Chartbeat tracking (disabled by default).
Jonne Haß's avatar
Jonne Haß committed
331
    #chartbeat_uid:
Dennis Schubert's avatar
Dennis Schubert committed
332

333
    ## Statistics
334 335
    ## Your pod will report its name, software version and whether
    ## or not registrations are open via /statistics.json.
Dennis Schubert's avatar
Dennis Schubert committed
336
    ## Uncomment the options below to enable more statistics.
337
    statistics: ## Section
338

339
      ## Local user total and 6 month active counts.
340
      #user_counts: true
341

342
      ## Local post total count.
343
      #post_counts: true
344
      #comment_counts: true
Dennis Schubert's avatar
Dennis Schubert committed
345

346
    ## Use Camo to proxy embedded remote images.
Dennis Schubert's avatar
Dennis Schubert committed
347 348 349
    ## Do not enable this setting unless you have a working Camo setup. Using
    ## camo to proxy embedded images will improve the privacy and security of
    ## your pod's frontend, but it will increase the traffic on your server.
350 351
    ## Check out https://wiki.diasporafoundation.org/Installation/Camo for
    ## more details and installation instructions.
Dennis Schubert's avatar
Dennis Schubert committed
352 353
    camo: ## Section

354
      ## Proxy images embedded via markdown (default=false).
355 356 357 358
      ## Embedded images are quite often from non-SSL sites and may cause a
      ## partial content warning, so this is recommended.
      #proxy_markdown_images: true

359
      ## Proxy Open Graph thumbnails (default=false).
360 361 362 363
      ## Open Graph thumbnails may or may not be encrypted and loaded from
      ## servers outside the network. Recommended.
      #proxy_opengraph_thumbnails: true

364
      ## Proxy remote pod's images (default=false).
365 366 367 368 369
      ## Profile pictures and photos from other pods usually are encrypted,
      ## so enabling this is only useful if you want to avoid HTTP requests to
      ## third-party servers. This will create a lot of traffic on your camo
      ## instance. You have been warned.
      #proxy_remote_pod_images: true
Dennis Schubert's avatar
Dennis Schubert committed
370 371

      ## Root of your Camo installation
372
      #root: "https://example.com/camo/"
Dennis Schubert's avatar
Dennis Schubert committed
373 374 375 376

      ## Shared key of your Camo installation
      #key: "example123example456example!"

Jonne Haß's avatar
Jonne Haß committed
377
  ## General settings
378
  settings: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
379

380 381
    ## Pod name (default="diaspora*")
    ## The pod name displayed in various locations, including the header.
382
    #pod_name: "diaspora*"
383 384

    ## Allow registrations (default=true)
385
    ## Set this to false to prevent people from signing up to your pod
386 387
    ## without an invitation. Note that this needs to be set to true
    ## (or commented out) to enable the first registration (you).
388
    #enable_registrations: true
Dennis Schubert's avatar
Dennis Schubert committed
389

390 391
    ## Auto-follow on sign-up (default=true)
    ## Users will automatically follow a specified account on creation.
392 393
    ## Set this to false if you don't want your users to automatically
    ## follow an account upon creation.
394
    #autofollow_on_join: true
Dennis Schubert's avatar
Dennis Schubert committed
395

396
    ## Auto-follow account (default='diasporahq@joindiaspora.com')
397
    ## The diaspora* HQ account keeps users up to date with news about Diaspora.
398
    ## If you set another auto-follow account (for example your podmin account),
399
    ## please consider resharing diaspora* HQ's posts for your pod's users!
400
    #autofollow_on_join_user: 'diasporahq@joindiaspora.com'
maruf's avatar
maruf committed
401

402
    ## Invitation settings
403
    invitations: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
404

405 406
      ## Enable invitations (default=true)
      ## Set this to false if you don't want users to be able to send invites.
407
      #open: true
Dennis Schubert's avatar
Dennis Schubert committed
408

409
      ## Number of invitations per invite link (default=25)
410 411
      ## Every user will see such a link if you have enabled
      ## invitations on your pod.
412
      #count: 25
Dennis Schubert's avatar
Dennis Schubert committed
413

414 415 416 417 418 419 420 421
    ## Paypal donations (disabled by default)
    ## You can set details for a Paypal button here to allow donations
    ## towards running the pod.
    ## First, enable the function, then set the currency in which you
    ## wish to receive donations, and **either** a hosted button id
    ## **or** an encrypted key for an unhosted button.
    paypal_donations: ## Section
      #enable: false
422

423 424
      ## Currency used (USD, EUR...)
      #currency: USD
425

426 427 428
      ## hosted Paypal button id
      #paypal_hosted_button_id: "change_me"
      ## OR encrypted key of unhosted button
429
      #paypal_unhosted_button_encrypted: "-----BEGIN PKCS7-----"
Dennis Schubert's avatar
Dennis Schubert committed
430

431
    ## Bitcoin donations
432 433 434
    ## You can provide a bitcoin address here to allow your users to provide
    ## donations towards the running of their pod.
    #bitcoin_address: "change_me"
Dennis Schubert's avatar
Dennis Schubert committed
435

436 437 438 439
    ## Community spotlight (disabled by default)
    ## The community spotlight shows new users public posts from people you
    ## think are interesting in Diaspora's community. To add an account
    ## to the community spotlight add the 'spotlight' role to it.
440
    community_spotlight: ## Section
441

442
      #enable: true
443

444 445
      ## E-mail address to which users can make suggestions about who
      ## should be in the community spotlight (optional).
Jonne Haß's avatar
Jonne Haß committed
446
      #suggest_email: 'admin@example.org'
Dennis Schubert's avatar
Dennis Schubert committed
447

448 449
    ## CURL debug (default=false)
    ## Turn on extra verbose output when sending stuff. Note: you
450
    ## don't need to touch this unless explicitly told to.
451
    #typhoeus_verbose: false
Dennis Schubert's avatar
Dennis Schubert committed
452

453 454
    ## Maximum number of parallel HTTP requests made to other pods (default=20)
    ## Be careful, raising this setting will heavily increase the memory usage
455 456
    ## of your Sidekiq workers.
    #typhoeus_concurrency: 20
457 458 459 460 461

    ## Captcha settings
    captcha: ## Section

      ## Enable captcha (default=true)
462
      ## Set this to false if you don't want to use captcha for signup process.
463
      #enable: true
464 465

      ## Captcha image size (default='120x20')
466
      #image_size: '120x20'
467

468
      ## Length of captcha text (default=5)(max=12)
469
      #captcha_length: 5
470 471 472 473

      ## Captcha image style (default='simply_green')
      ## Available options for captcha image styles are: 'simply_blue',
      ## 'simply_red' 'simply_green', 'charcoal_grey', 'embossed_silver',
474
      ## 'all_black', 'distorted_black', 'almost_invisible', 'random'.
475
      #image_style: 'simply_green'
476 477 478

      ## Captcha image distortion (default='low')
      ## Sets the level of image distortion used in the captcha.
479
      ## Available options are: 'low', 'medium', 'high', 'random'.
480
      #distortion: 'low'
Dennis Schubert's avatar
Dennis Schubert committed
481

482 483 484 485 486 487 488 489 490 491 492 493 494 495
    ## Terms of Service
    ## Show a default or customized terms of service for users.
    ## You can create a custom Terms of Service by placing a template
    ## as app/views/terms/terms.haml or app/views/terms/terms.erb
    ## The default terms of service that can be extended is
    ## at app/views/terms/default.haml
    ## NOTE! The default terms have not been checked over by a lawyer and
    ## thus are unlikely to provide full legal protection for all situations
    ## for a podmin using them. They are also not specific to all countries
    ## and jurisdictions. If you are unsure, please check with a lawyer.
    ## We provide these for podmins as some basic rules that podmins
    ## can communicate to users easily via the diaspora* server software.
    ## Uncomment to enable this feature.
    terms: ## Section
496 497

      ## First enable it by uncommenting below.
498
      #enable: true
499

500 501 502 503 504 505 506
      ## Important! If you enable the terms, you should always
      ## set a location under which laws any disputes are governed
      ## under. For example, country or state/country, depending
      ## on the country in question.
      ## If this is not set, the whole paragraph about governing
      ## laws *is not shown* in the terms page.
      #jurisdiction: ""
507 508

      ## Age limit for signups.
509 510 511
      ## Set a number to activate this setting. This age limit is shown
      ## in the default ToS document.
      #minimum_age: false
Dennis Schubert's avatar
Dennis Schubert committed
512

513 514 515
    ## Maintenance
    ## Various pod maintenance related settings are controlled from here.
    maintenance: ## Section
516 517

      ## Removing old inactive users can be done automatically by background
518 519 520 521 522
      ## processing. The amount of inactivity is set by `after_days`. A warning
      ## email will be sent to the user and after an additional `warn_days`, the
      ## account will be automatically closed.
      ## This maintenance is not enabled by default.
      remove_old_users: ## Section
523

524 525 526
        #enable: true
        #after_days: 730
        #warn_days: 30
527

528 529
        ## Limit queuing for removal per day.
        #limit_removals_to_per_day: 100
530

531 532 533 534 535
    ## Source code URL
    ## URL to the source code your pod is currently running.
    ## If not set your pod will provide a downloadable archive.
    #source_url: 'https://example.org/username/diaspora'

536 537 538
    ## Default color theme
    ## You can change which color theme is displayed when a user is not signed in
    ## or has not selected any color theme from the available ones. You simply have
539 540 541
    ## to enter the name of the theme's folder in "app/assets/stylesheets/color_themes/".
    ## ("original" for the theme in "app/assets/stylesheets/color_themes/original/", for
    ## example).
542
    #default_color_theme: "original"
543
  ## Posting from Diaspora to external services (all are disabled by default).
544 545
  services: ## Section

546
    ## OAuth credentials for Facebook
547
    facebook: ## Section
548

549 550 551
      #enable: true
      #app_id: 'abcdef'
      #secret: 'change_me'
Dennis Schubert's avatar
Dennis Schubert committed
552

553 554 555 556 557 558 559
      ## This setting is required to define whether the Facebook app has permissions to post
      ##   false == No permissions (default)
      ##   true == Permissions for all users to post. App MUST have 'publish_actions' approved by Facebook!
      ##   "username" == Set to local username to allow a single user to cross-post. The person who has created
      ##                 the Facebook app will always be able to cross-post, even without 'publish_actions'.
      #authorized: false

560
    ## OAuth credentials for Twitter
561
    twitter: ## Section
562

563 564 565
      #enable: true
      #key: 'abcdef'
      #secret: 'change_me'
Dennis Schubert's avatar
Dennis Schubert committed
566

567 568
    ## OAuth credentials for Tumblr
    tumblr: ## Section
569

570 571 572
      #enable: true
      #key: 'abcdef'
      #secret: 'change_me'
Dennis Schubert's avatar
Dennis Schubert committed
573

574 575
    ## OAuth credentials for Wordpress
    wordpress: ## Section
576

577 578 579
      #enable: true
      #client_id: 'abcdef'
      #secret: 'change_me'
Dennis Schubert's avatar
Dennis Schubert committed
580

581
  ## Allow your pod to send emails for notifications, password recovery
582
  ## and other purposes (disabled by default).
583
  mail: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
584

585
    ## First you need to enable it.
Jonne Haß's avatar
Jonne Haß committed
586
    #enable: true
Dennis Schubert's avatar
Dennis Schubert committed
587

588
    ## Sender address used in mail sent by Diaspora.
Jonne Haß's avatar
Jonne Haß committed
589
    #sender_address: 'no-reply@example.org'
Dennis Schubert's avatar
Dennis Schubert committed
590

591
    ## This selects which mailer should be used. Use 'smtp' for a smtp
Jonne Haß's avatar
Jonne Haß committed
592 593
    ## connection, 'sendmail' to use the sendmail binary or
    ## 'messagebus' to use the messagebus service.
594
    #method: 'smtp'
Dennis Schubert's avatar
Dennis Schubert committed
595

596
    ## Ignore if method isn't 'smtp'.
597
    smtp: ## Section
598

Jonne Haß's avatar
Jonne Haß committed
599
      ## Host and port of the smtp server handling outgoing mail.
600
      ## This should match the common name of the certificate sent by
601
      ## the SMTP server, if it sends one. (default port=587)
Jonne Haß's avatar
Jonne Haß committed
602
      #host: 'smtp.example.org'
603
      #port: 587
Dennis Schubert's avatar
Dennis Schubert committed
604

605
      ## Authentication required to send mail (default='plain').
606 607
      ## Use one of 'plain', 'login' or 'cram_md5'. Use 'none'
      ## if server does not support authentication.
608
      #authentication: 'plain'
Dennis Schubert's avatar
Dennis Schubert committed
609

610
      ## Credentials to log in to the SMTP server.
611 612 613
      ## May be necessary if authentication is not 'none'.
      #username: 'change_me'
      #password: 'change_me'
Dennis Schubert's avatar
Dennis Schubert committed
614

615
      ## Automatically enable TLS (default=true).
616
      ## Leave this commented out if authentication is set to 'none'.
617
      #starttls_auto: true
Dennis Schubert's avatar
Dennis Schubert committed
618

619
      ## The domain for the HELO command, if needed.
Jonne Haß's avatar
Jonne Haß committed
620
      #domain: 'smtp.example.org'
Dennis Schubert's avatar
Dennis Schubert committed
621

622
      ## OpenSSL verify mode used when connecting to a SMTP server with TLS.
623 624
      ## Set this to 'none' if you have a self-signed certificate. Possible
      ## values: 'none', 'peer', 'client_once', 'fail_if_no_peer_cert'.
625
      #openssl_verify_mode: 'none'
Dennis Schubert's avatar
Dennis Schubert committed
626

Jonne Haß's avatar
Jonne Haß committed
627
    ## Ignore if method isn't 'sendmail'
628
    sendmail: ## Section
629 630

      ## The path to the sendmail binary (default='/usr/sbin/sendmail')
631
      #location: '/usr/sbin/sendmail'
Dennis Schubert's avatar
Dennis Schubert committed
632

633
      ## Use exim and sendmail (default=false)
634
      #exim_fix: false
Dennis Schubert's avatar
Dennis Schubert committed
635

Jonne Haß's avatar
Jonne Haß committed
636 637
    ## Ignore if method isn't 'messagebus'
    #message_bus_api_key: 'abcdef'
Dennis Schubert's avatar
Dennis Schubert committed
638

639
  ## Administrator settings
640
  admins: ## Section
Dennis Schubert's avatar
Dennis Schubert committed
641

642
    ## Set the admin account.
Jonne Haß's avatar
Jonne Haß committed
643
    ## This doesn't make the user an admin but is used when a generic
644
    ## admin contact is needed, much like the postmaster role in mail
Jonne Haß's avatar
Jonne Haß committed
645 646
    ## systems. Set only the username, NOT the full ID.
    #account: "podmaster"
movilla's avatar
movilla committed
647

648
    ## E-mail address to contact the administrator.
movilla's avatar
movilla committed
649
    #podmin_email: 'podmin@example.org'
Dennis Schubert's avatar
Dennis Schubert committed
650

651
## Here you can override settings defined above if you need
Jonne Haß's avatar
Jonne Haß committed
652
## to have them different in different environments.
653
production: ## Section
Jonne Haß's avatar
Jonne Haß committed
654 655
  environment: ## Section
    #redis_url: 'redis://production.example.org:6379'
Dennis Schubert's avatar
Dennis Schubert committed
656

657 658
development: ## Section
  environment: ## Section
Jonne Haß's avatar
Jonne Haß committed
659
    #redis_url: 'redis://production.example.org:6379'