Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/system-admin-guide/custom-fields/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,19 @@ To **edit an existing custom field** select the appropriate tab and click on the
To **delete** a custom field, click on the delete icon next to the respective custom field in the list.

![Edit or delete a custom field in OpenProject administration](system-admin-edit-delete-custom-field.png)

## Define custom field help text

To define field caption and help text click on an existing custom field and navigate to **Attribute help texts** tab. Here you can define the following:

- **Caption** - a short text that will be displayed as a custom field caption to provide context.
- **Help text** - a longer text that will be shown when a user hovers over a question mark next to the custom field name. Here you can provide more detailed explanation. This is a required field.
- **Attachments** - attach files or images to illustrate a custom field.

> [!IMPORTANT]
>
> Any text and images you add here will be publicly visible to all logged in users.



![Work package custom field detailed view, showing *Attribute help texts* tab in OpenProject administration](open_project_system_admin_guide_custom_field_attribute_text.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 21 additions & 3 deletions docs/system-admin-guide/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Under **Interface** you can also choose [custom colors](#interface-colors) for e

![Design interface settings in OpenProject administration](openproject_system_guide_design_interface.png)

Under the **Branding** tab you can also [upload a custom logo](#upload-a-custom-logo) to replace the default OpenProject logo, [set a custom favicon](#set-a-custom-favicon), which is shown as an icon in your browser window/tab, and [upload a custom touch icon](#set-a-custom-touch-icon), which is shown on your smartphone or tablet when you bookmark OpenProject on your home screen.
Under the **Branding** tab you can also [upload a custom desktop and/or mobile logos](#upload-a-custom-logo) to replace the default OpenProject logo, [set a custom favicon](#set-a-custom-favicon), which is shown as an icon in your browser window/tab, and [upload a custom touch icon](#set-a-custom-touch-icon), which is shown on your smartphone or tablet when you bookmark OpenProject on your home screen.

![Branding settings in OpenProject administration](openproject_system_guide_design_branding.png)

Expand All @@ -33,7 +33,6 @@ You can
* upload a logo to be used in the exported PDF header
* upload a custom background image for exports with a cover page
* adjust the text color of the text overlay at the custom background image of the cover page
* upload a design image that is placed on the left side of the footer

> [!TIP]
> You can generate a demo PDF to see a preview of your settings. Click the **Generate Demo PDF** button.
Expand Down Expand Up @@ -68,15 +67,34 @@ Press the Save button to apply your changes. The theme will then be changed.
![Change color theme in OpenProject administration settings](openproject_system_guide_design_color_theme_navy_blue.png)

## Upload a custom logo
In the Administration → Design area, you can replace the standard OpenProject logo with your own branding.

To replace the default OpenProject logo with your own logo, make sure that your logo has the dimensions 460 by 60 pixels. Select the *Browse* button and select the file from your hard drive to upload it.
### Custom logo desktop
This field to upload the version of your logo that should appear on larger screens. The logo you upload will automatically scale to fit the header. For best results, we recommend uploading a white logo on a transparent 130×47px image. You can add as much spacing inside that image as you like.

Select the *Browse* button and select the file from your hard drive to upload it.

Click the *Upload* button to confirm and upload your logo.

![Upload custom logo in OpenProject administration settings](openproject_system_guide_design_upload_custom_logo.png)

![Custom logo updated in OpenProject administration](openproject_system_guide_design_custom_logo_uploaded.png)

### Custom logo mobile

A separate Custom logo mobile section allows you to provide an alternative logo optimized for smaller displays.

### Logo display behavior

Depending on which custom logos are uploaded, OpenProject will adjust the displayed logo according to the following principles:

- If both desktop and mobile logos are provided, the logo switches responsively with the screen size.
- If only a mobile logo is available, it will be used everywhere.
- If only a desktop logo is uploaded, it will appear on desktop screens, while mobile views will not show a logo.
- If no logo is uploaded, OpenProject continues to display its default logo.
- When a custom logo is in use, a separate high-contrast version is no longer enforced.


## Set a custom favicon

To set a custom favicon to be shown in your browser’s tab, make sure you have a PNG file with the dimensions 32 by 32 pixels. Select the *Choose File* button and select the file from your hard drive to upload it.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 37 additions & 7 deletions docs/system-admin-guide/projects/new-project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,50 @@ sidebar_navigation:
title: New project
priority: 200
description: Choose which modules are enabled by default for new projects and the role given to non-admin users who create a project
keywords: new project, settings, default, modules
keywords: new project, settings, default, modules, project settings, project notifications, project template
---

# New project
The New project settings allow instance administrators to define default configuration values applied at project creation time. These settings allow you to configure:

To set defaults for new projects, navigate to **Administration settings** → **Projects** → **New project**.
- Default project visibility (public or private)
- Project modules enabled at creation time
- The initial project role assigned to non-admin project creators
- Notification behavior upon project creation

To configure defaults for newly created projects, navigate to *Administration settings → Projects → New project*.

![New project settings in OpenProject administration](open_project_system_guide_new_project_settings.png)

> [!TIP]
> Changes made on this page apply **globally** to the instance and affect only projects created after the settings are saved. Existing projects and their configurations remain unchanged.

## New project settings

![New project settings in OpenProject administration](open_project_system_guide_new_project_settings.png)

You will find the following options on this page:
The following options are available on the **New project** settings page:

- **New projects are public by default**
When enabled, newly created projects are marked as **public** by default. Public projects are visible to all users according to their global permissions.
- **Enabled**: Projects are created as public.
- **Disabled**: Projects are created as private and must be explicitly changed to public by a project administrator.

- **Default enabled modules for new projects**
Defines which project modules are activated automatically when a project is created.
- Selected modules are enabled by default for all new projects.
- Project administrators can modify module availability at any time from the project settings.

- **Role given to a non-admin user who creates a project**
Specifies the **project-level role** automatically assigned to a user who creates a project and is not an instance administrator.
- Default value: **Project admin**
- The assigned role defines the permissions granted to the creator immediately after project creation.

Once you have adjusted the settings, click **Save** to apply them across the instance.


**New projects are public by default**: Check this option to make new projects public by default when they are created. If this is unchecked, all new projects will be private by default and will have to be marked as public manually.
## New project notifications

- **Default enabled modules for new projects:** The checked modules will be enabled by default when a new project is created. Project admins can enable or disable specific modules later.
- **Role given to a non-admin users who creates project**: The default role you want to assign *in the project* to the user that created it (if this user is not an instance admin). By default, the default role is 'Project admin'.
![New project notifications tab in OpenProject administration](open_project_system_guide_new_project_settings_notifications.png)

Once you make your modifications, click on **Save** to apply the settings instance-wide.
The **Notifications** tab controls whether a confirmation notification is sent to the project creator when a new project is created. When enabled, the project creator receives a notification confirming successful project creation.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading