Skip to content

Commit 309b8e4

Browse files
authored
Merge pull request #13786 from nextcloud/jtr/fix-theming-not-optional
fix(theming): App isn't optional these days + misc section tidying
2 parents 716cfc6 + 3351318 commit 309b8e4

File tree

1 file changed

+43
-49
lines changed

1 file changed

+43
-49
lines changed

admin_manual/configuration_server/theming.rst

Lines changed: 43 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,84 +2,78 @@
22
Theming
33
=======
44

5-
With our theming feature, you are able to customize the look and feel of your
6-
Nextcloud instance according to the corporate design of your organization by
7-
replacing the Nextcloud logo and color with your own assets.
5+
The theming feature lets you customize the look and feel of your Nextcloud instance to match your organization's design (or - if for personal use - your own style). You can replace the Nextcloud logo and background images with your own assets, customize colors and slogans, and add dedicated legal and privacy links.
86

9-
The theming app is enabled by default so the section should appear by default in
10-
your admin-settings. If not, check in the apps management that this app is enabled.
7+
Theme customization is provided by the shipped and always-enabled ``theming`` app. Use the **Theming** section within the *Administration settings* menu to access all theming-related settings.
118

12-
Modify the appearance of Nextcloud
13-
----------------------------------
9+
Customize the appearance of Nextcloud
10+
-------------------------------------
1411

15-
You can change the following parameters of the look and feel on your instance:
12+
You can change the following aspects of your instance's appearance:
1613

1714
.. figure:: ../configuration_server/images/theming1.png
1815

19-
* Name (e.g. ACME Inc. Cloud)
20-
* Web link (e.g. https://acme.inc/)
21-
* Slogan
22-
* Primary color: The color used for important buttons, checkboxes, and folder icon
23-
* Background color: The background color if no image is used, the color of header bar icons is also generated from this
24-
* Logo: The logo will appear in the header and on the login page. The default has 62/34 px.
25-
* Background and login image: The background image
16+
* **Name** (e.g., ACME Inc. Cloud).
17+
* **Web link** (e.g., https://acme.inc/).
18+
* **Slogan**.
19+
* **Primary color**: Used for important buttons, checkboxes, and folder icons.
20+
* **Background color**: Used when no image is set; header bar icon color is also derived from this.
21+
* **Logo**: Appears in the header and on the login page (default size: 62x34 px).
22+
* **Background and login image**: Sets the page background.
2623

2724
.. figure:: ../configuration_server/images/theming2.png
2825

29-
* Additional legal links (Legal notice and Privacy policy link)
30-
* Custom header logo and favicon as an alternative to auto-generation based on logo
31-
* Disable user theming: Although you can select and customize your instance, users can change their backgrounds and colors. If you want to enforce your customization, you can toggle this on.
32-
26+
* **Additional legal links**: Legal notice and privacy policy.
27+
* **Custom header logo and favicon**: Optionally override the auto-generated favicon based on your logo.
28+
* **Disable user theming**: Prevent users from changing backgrounds and colors. Toggle this to enforce your custom theme.
3329

34-
Configure theming through CLI
35-
-----------------------------
30+
Configure theming via CLI
31+
-------------------------
3632

37-
Theming configuration can also be adjusted through the ``occ theming:config`` command.
33+
You can also configure theming using the ``occ theming:config`` command.
3834

39-
The following values are available to be set through this:
35+
Available settings include:
4036

41-
- name, url, imprintUrl, privacyUrl, slogan, color, primary_color ``occ theming:config name "My Example Cloud"``
42-
- background, logo, favicon, logoheader ``occ theming:config logo /tmp/mylogo.png``
43-
- disable-user-theming (yes/no) ``occ theming:config disable-user-theming yes``
37+
- `name`, `url`, `imprintUrl`, `privacyUrl`, `slogan`, `color`, `primary_color`.
38+
Example: ``occ theming:config name "My Example Cloud"``
39+
- `background`, `logo`, `favicon`, `logoheader`.
40+
Example: ``occ theming:config logo /tmp/mylogo.png``
41+
- `disable-user-theming` (yes/no).
42+
Example: ``occ theming:config disable-user-theming yes``
4443

45-
.. note:: Images require to be read from a local file on the Nextcloud server
44+
.. note:: Images must be read from a local file on the Nextcloud server.
4645

47-
Use a color instead of an image as a background:
46+
To use a color (instead of an image) for the background:
4847

4948
::
5049

5150
occ theming:config color "#0082c9"
5251
occ theming:config background backgroundColor
5352

54-
Theming of icons
55-
----------------
53+
Icon theming
54+
------------
5655

57-
According to the parameters you have set, Nextcloud will automatically generate
58-
favicons and a header logo depending on the current logo and theming color.
56+
Based on your settings, Nextcloud will automatically generate favicons and a header logo using your logo and theme color.
5957

60-
This requires the following additional dependencies:
58+
This requires:
6159

62-
- PHP module ``imagick``
63-
- SVG support for imagick (e.g. ``libmagickcore-6.q16-3-extra`` on Debian 9 and Ubuntu 18.04)
60+
- The PHP ``imagick`` module.
61+
- SVG support for imagick (e.g., ``libmagickcore-7.q16-10-extra`` on Debian 13 and ``libmagickcore-6.q16-7-extra`` on Ubuntu 24.04).
6462

65-
.. note:: In the advanced options of the theming app you are able to set a custom
66-
favicon in case you do not want to use the same logo resources you have set above
67-
or you do not want to install the mentioned dependencies.
63+
.. tip:: In the advanced options of the theming app, you can set a custom favicon if you do not want to use auto-generated resources or install the above dependencies.
6864

6965
Branded clients
7066
---------------
7167

72-
.. note:: Nextcloud GmbH provides branding services, delivering sync clients (mobile
73-
and desktop) which use your corporate identity and are pre-configured to help your
74-
users get up and running in no time. If you are interested in our advanced branding &
75-
support subscription, `contact our sales team <https://nextcloud.com/enterprise/>`_.
76-
77-
The theming app supports changing the URLs to the mobile apps (Android & iOS) that
78-
are shown when the web interface is opened on one of those devices. Then there was a
79-
header shown, that redirects the user to the app in the app store. By default,
80-
this redirects to the Nextcloud apps. In some cases, it is wanted that this
81-
links to branded versions of those apps. In those cases the IDs and URLs can be
82-
set via the ``occ``-command::
68+
.. TODO: Consider dropping this section (other than the note) since this isn't even available/applicable for non-enterprise users (who presumably will use docs at https://portal.nextcloud.com).
69+
70+
.. note:: Nextcloud GmbH - the company that employs Nextcloud's core maintainers - offers branding services, providing sync clients (mobile and desktop) that use your corporate identity and are pre-configured for your users. For more information on advanced branding and enterprise support offerings, `contact Nextcloud GmbH <https://nextcloud.com/enterprise/>`_.
71+
72+
The theming app supports changing the URLs for the mobile apps (Android and iOS) that appear when users access the web interface from mobile devices. By default, these links point to the official Nextcloud apps, but you can set them to branded versions.
73+
74+
Set custom app links using the ``occ`` command:
75+
76+
::
8377

8478
occ config:app:set theming AndroidClientUrl --value "https://play.google.com/store/apps/details?id=com.nextcloud.client"
8579
occ config:app:set theming iTunesAppId --value "1125420102"

0 commit comments

Comments
 (0)