Access Keys:
Skip to content (Access Key - 0)

Adaptavist Documentation Move

This documentation is deprecated. Adaptavist's documentation has moved to a new location where it is maintained and updated. Please visit Adaptavist's new Documentation area.

General Configuration

All of the most common settings for Confluence are defined within the General Configuration screen...

Displaying and Editing the Configuration Settings

To display the current configuration, click the General Configuration link on the navigation panel.

To edit the configuration, click on the Edit button at the bottom.

Options and Settings

Because there are so many settings, we've highlighted (using a ) the ones that you should always review immediately after installing Confluence...

Camel Case Links

CamelCase is the name given to the practice of joining words together by capitalising the first letter of each word. Many wiki's use CamelCase words to create links to pages, a process known as CamelCase Links, however by default Confluence does not use this linking format (see our tutorials on Links for details of the standard linking notation in Confluence).

If you wish to enable CamelCase linking, you can do so with this setting. When enabled, you can disable individual CamelCase links by using the nl macro or nolink macro, for example:

ThisIsLinked {nl}ButThisIsNot{nl}

TrackBack

TrackBack is a way for one website to automatically notify another of links. With TrackBack enabled, when you link to another TrackBack enabled site, that site will be informed that you have created the link and any site can send a TrackBack to your site for the same purpose.

  • On – Trackback is enabled (recommended for publicly accessible sites)
  • Off – Trackback is disabled (recommended for sites that contain some secure or sensitive content)
Security / Privacy Warning
When enabled, any trackback-enabled website you link to will display a link back to your site. That link will usually contain the page title – if you have sensitive information on your site, turn off trackbacks.

If trackbacks are enabled, you can find out which other trackback-enabled sites are linking to your pages by displaying the Page Information screen.

Remote API (XML-RPC & SOAP)

Enables or disables the remote (XML-RPC and SOAP) Confluence APIs which allow external applications to perform various tasks such as adding, deleting and altering content on your site:

  • On – External software can perform Confluence tasks using the API
  • Off (recommended) – The API is disabled.

The API usually requires a user login in order to perform any tasks and as such those tasks are restricted by the security settings for that user. For example, if that user cannot delete pages through the web interface, they won't be able to delete pages through the API.

Unless you understand exactly what the API does, turn it off!
While it is impossible to do anything with the remote API that you can not do through the regular interface, having the remote API enabled does make it easier for people to write automated tools that deface the site.

Anonymous Access to Remote API

If you have enabled anonymous access to Confluence, but do not wish anonymous users to access the site via the remote API, you can use this setting to ensure that only registered users can use the API.

  • On – Anonymous users can use the API
  • Off (recommended) – Only registered users can use the API

Unless you fully understand the implications of this setting, always disable anonymous access to the API (i.e. turn this setting OFF).

View Space Goes to Browse Space

When users enter a space, this setting specifies whether they are shown the Space Homepage or the Space browser (index, lables, etc).

  • On – The space browser is shown
  • Off (recommended) – The space homepage is shown

Note: The space browser will often not show what you expect – sometimes it will show the last screen viewed within the browser and other times it will show some other screen. In our view, it's best to always show a consistent screen when entering a Space and as such we recommend that this option be set to Off.

External User Management

This setting defines whether user accounts are stored within Confluence or some external application (e.g. an LDAP server).

  • On – External user management is used
  • Off (recommended) – User management is controlled by Confluence

If you require external user management, please ${renderedContent}

Public Signup

If enabled, anyone can create a user account on your site. If disabled, an Administrator will have to manually create user accounts.

  • On (default) – Anonymous users can come to your site and create a user account
  • Off (recommended) – Only administrators can create user accounts

If your site is open to the public, then you can choose to leave this setting turned on.

Bear in mind that depending on your Confluence license you may have a maximum of 2, 5, 25, 50, 500 or unlimited users (there are other licenses which allow varying amounts of users between 200 to 100,000, but these are usuall reserved for non-profit or open source organisations). If public sign-up is enabled, you could end up running out of user accounts and find yourself unable to create accounts for people you want or need to have accounts.

If your site is secure, such as an Intranet, then generally you will want to disable this option.

If you are using external user management then you should disable this option.

Threaded Comments

With sufficient privileges users of your site can add comments to the end of pages and news articles (also known as blogs). This setting determines whether comments are displayed chronologically or as threads.

  • On (recommended) – Users can reply to other comments that have already been made. Replies are shown below the comment they relate to with increasing indentation the deeper in to the threadded discussion they are.
  • Off (default) – Coments are shown chronologically with the oldest at the top and the newest at the bottom.

Hide External Links From Search Engines

If you turn this option on, any links in your content that lead to external sites will be given the nofollow attribute which prevents search engines (such as Google) from following them.

This helps discourage spammers from posting links on your site as those links won't be indexed by the search engine.

Shortcut links and links to other pages within Confluence are not affected so search engines will still follow them.

  • On (recommended) – To keep search engines focussed on your site, hide the external links from them.
  • Off – Allow search engines to follow links to external sites.

Enable Rich Text Editing

If you want to allow users to use the Rich Text Editor, enable this option.

  • On (recommended) – Allow users to edit content using the visual Rich Text (or What You See is What You Get - WYSIWYG) editor.
  • Off – Force all users to use the Wiki Markup Editor.

Users see Rich Text Editor by Default

If you've enabled the Rich Text Editor (see above), you can choose whether it is the default editor shown to users.

  • On (default) – Users are presented with the Rich Text Editor by default
  • Off – Users are presented with the Wiki Markup Editor by default

If the Rich Text Editor is enabled, then users can switch between it and the Wiki Markup Editor (which is always available) at will. They can also choose which they want to use by default – for more information, please see our tutorials on the Rich Text Editor and the Wiki Markup Editor. Users can also set which editor they prefer in their User Profile.

Compress HTTP Responses

Added in Confluence 2.1.4, this option allows all Confluence content to be compressed for compatible web browsers. Should a user have a browser that cannot handle compression, the Confluence content will be sent uncompressed.

  • On – Compress content sent to users where possible.
  • Off (default) – Don't compress content.

There are various arguments for and against this feature as follows:

  • Compressing content will reduce your bandwidth requirements
  • Compressing content will increase load on your server's processor
  • With modern Internet connections, it's unclear as to whether the compression will have any benefit

If in doubt, give it a try! Your end users will soon tell you if it's better or worse.

Note: In some hosted environments, particularly those which place an additional web server (such as Apache) in front of Confluence, it's possible that the compression setting will not have any effect.

User Email Visibility

There are three options for this setting:

  • Public (default) – email addresses are shown, increasing the liklihood that the owner of the email address will receive a lot more spam
  • Masked (recommended) – email addresses are masked, for example joe.blogs at whatever dot com.
  • Only visible to site administrators – does exactly what you'd expect.

Note that this setting only applies to certain email addresses within Confluence, most notably the email address for each user and any email addresses that are added with the "mailto" link. Any other occurences of email addresses will not be affected by this setting and as such will be treated as "public".

There is a growing trend for users to use their email address as their login user name. If they do this, their email address will be displayed (or present in the underlying HTML of pages they contribute to) throughout the site in it's "public" form. Because usernames cannot be altered, we advise against using email addresses as user names.

Site Homepage

Anonymous users (and indeed most registered users) will, by default, be shown The Dashboard when the first come to your site.

You can, however, choose to display a the homepage for a specific space as the site home page by selecting the space from the drop-down list. For example, rather than showing the Dashboard you might prefer to show the homepage of a space called "Welcome".

In order to do this, the "Welcome" space must be visible to anonymous users. For more information, please see our tutorial on setting the Site Homepage.

Note: You can create links anywhere on your site to the site homepage using the link-to macro.

Registered users are able to define their own preference for the site homepage in their User Profile. For example, they may choose to use a different Space (including spaces that they have access to but anonymous users do not), the Dashboard or even their own user profile.

Site Title

This setting defines the "title" of your site. It appears in many locations such as The Dashboard and global screens such as Search Results, etc. Most notably, the site title is shown in the web browser title bar throughout your entire site and as such this title will often be displayed in search results on external search engines such as Google.

Maximum Attachments per Form

Added in Confluence 2.1.4, this setting allows you to choose the maximum number of Attachments that can be uploaded to Pages, News Articles or User Profiles at the same time.

By default, when you are uploading attachments you only see one field to select a file. If this setting is set to more than "1" (one) then you will also see an "Attach more files" link - clicking that link will display additional fields thus allowing you upload more than one attachment at a time.

The default maximum number of attachments is five, but you can set it to any number (within reason) depending on your preferences. If you know that there will be many occasions where large numbers of files will need to be uploaded at the same time (eg. uploading a photo album) then you can increase the number to allow more files to be specified on a single upload (saves time).

If in doubt, leave this setting at the default maximum of "5".

Attachment Maximum Size (B)

This defines the largest size of a single file attachment in bytes. Should someone attempt to upload a file bigger than that specified by this setting, Confluence will refuse to accept the file.

By default, the maximum size is 10485760 (10MB). That's a pretty big file to be uploading to a wiki, unless your wiki is on your office intranet / LAN.

To stop people from uploading excessively large files, we recommend setting the maximum size to 1048576 (1MB). You can set this smaller or bigger - it's up to you.

If you're hosting Confluence with an ISP then it's likely that you'll have to pay more if you use more disk space (storage of attachments), RAM (caching of attachment files) and bandwidth (transfer of attachments) - as such, you can reduce the maximum attachment size in order to reduce costs.

If you are only worried about bandwidth, it might be worth enabling compression.

Draft Save Interval

Added in Confluence 2.0, this feature defines the time between "auto-saves". While adding or editing pages, Drafts will automatically be saved in your User Profile – should your internet connection fail, or your web browser crash, etc., you can recover your changes from the point at which they were last auto-saved.

By default, anything you edit is automatically saved (effectively backed up as a draft) every 30 seconds. Unless you have good reason to choose a different interval, we recommend keeping this setting.

Site Welcome Message

The welcome message is displayed in the top-left corner of The Dashboard and also wherever you use the welcome-message macro.

If this setting is left empty, the the default welcome message will be shown:

Welcome to Confluence

Confluence is the enterprise wiki designed to make it easy for you and your team to share information with each other, and with the world.

Where do I start?

All content in Confluence is organised into spaces. So to start browsing content, simply click on one of the spaces listed below.

As you can imagine, it's generally better to customise the message so that it's more applicable to your site visitors - simply enter the desired message using Wiki Notation (which can include Macros) and it will appear on your dashboard, etc.

Indexing Language

This setting allows you to set the preferred language for the search engine that Confluence uses. By default it is set to English but there are a few alternate languages that you might find more appropriate depending on the most common language used on your site.

Server Base URL

This setting is absolutely critical if you want your site to work properly. If it's not set correctly, things will break!

Note that a Confluence site can ONLY have one Base URL setting. As such, if the site is accesible by more than one domain name, for example, then only the one that matches the Base URL will work properly. The others will seem to work, but you'll get reports of things randomly breaking or otherwise not working as you would expect them to.

Number of Ancestors to Show in Breadcrumbs

Added in Confluence 2.1.4, this setting allows you to "abbreviate" the breadcrumb trail that appears at the top of pages.

By default it is set to "4" which means that wherever you are, only 4 items will be listed before the current location. If you want to have more or fewer items shown on the breadcrumb trail simply increase or decrease the number in this setting.

For example, the page you are looking at now is located at:

Dashboard > User Guides > Home > Confluence > Administration Console > General Configuration

You'll notice however that some of the items do not appear in the breadcrumb trail at the top of this screen:

Dashboard > User Guides > ... > Administration Console > General Configuration

Some items have been replaced with an ellipsis (...) to shorten the breadcrumb trail so that only 4 items (Dashboard, User Guides, ... and Administration Console) appear before the link to this page.

You can click the ellipsis (...) to expand the breadcrumb trail so that it shows all items.

Note: We're using the Builder Theme which allows the Dashboard link to be hidden so you won't see that above.

Formatting

These options define common formats for numbers, dates and times, etc.

Encoding

Leave this setting as UTF-8 unless you know otherwise.

Time Format

By default this is set to hh:mm a which shows times in the format 03:08 PM.

You can choose an alternate format if desired - for more information see our tutorial on Date Formats.

Note: The "current time" is set by the server on which you install Confluence. If the times appear wrong, you'll have to change the time set on the server.

Date Time Format

This defines the format used when both date and time are required and by default is set to MMM dd, yyyy HH:mm which results in displays that look like Jun 07, 2006 00:45.

You can choose an alternate format if desired - for more information see our tutorial on Date Formats.

Note: The "current date" is set by the server on which you install Confluence. If the date appears to be wrong, you'll have to change the date set on the server.

Date Format

This defines the format used to display dates and by default is set to MMM dd, yyyy which results in displays that look like Jun 07, 2006.

You can choose an alternate format if desired - for more information see our tutorial on Date Formats.

Note: The "current date" is set by the server on which you install Confluence. If the date appears to be wrong, you'll have to change the date set on the server.

Long Number Format

This sets the format used to display numbers with no decimal part (whole numbers).

You can set a different format if desired - for more information see our tutorial on Number Formats.

Decimal Number Format

This sets the format used to display numbers with a decimal part (also known as real numbers).

You can set a different format if desired - for more information see our tutorial on Number Formats.

Thumbnails

Set the default maximum height and width for image thumbnails created using the "thumbnail" parameter, or the gallery macro.

Maximum Height

The maximum height of thumbnails, specified in pixels.

Maximum Width

The maximum width of thumbnails, specified in pixels.



View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence