forked from pivotal-cf/docs-ops-guide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcustom-branding.html.md.erb
77 lines (47 loc) · 6.42 KB
/
custom-branding.html.md.erb
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
---
title: Custom Branding Apps Manager
owner: Pivotal Application Service
---
This topic describes how <%= vars.product_name_full %> operators can visually brand Apps Manager by changing certain text, colors, and images of the interface. Developers view the customized interface when logging in, creating an account, resetting a password, or using Apps Manager.
Operators customize Apps Manager by configuring the **Custom Branding** and **Apps Manager Config** pages of the Pivotal Application Service (PAS) tile.
## <a id='generic'></a> Custom Branding Pane
To customize your Apps Manager interface:
1. In a browser, navigate to the fully qualified domain name (FQDN) of your Ops Manager and log in.
1. Click **Pivotal Application Service**.
1. Click **Custom Branding**.
<%= image_tag 'custombranding.png' %>
1. For **Company name**, enter the name of your organization. If left blank, the name defaults to **Pivotal**.
1. For **Accent color**, enter the hexadecimal code for the color used to accent various visual elements, such as the currently selected space in the sidebar. For example, `#71ffda`.
1. For **Main logo**, enter a Base64-encoded URL string for a PNG image to use as your main logo. The image can be square or wide. For example, `data:image/png;base64,iVBORw0...`. If left blank, the image defaults to the Pivotal logo.
1. For **Square logo**, enter a Base64-encoded URL string for a PNG image to use in the Apps Manager header and in places that require a smaller logo. For example, `data:image/png;base64,iVBORw0...`. If left blank, the image defaults to the Pivotal logo.
1. For **Favicon**, enter a Base64-encoded URL string for a PNG image to use as your favicon. For example, `data:image/png;base64,iVBORw0...`. If left blank, the image defaults to the Pivotal logo.
1. For **Footer text**, enter a string to be displayed as the footer. If left blank, the footer text defaults to **Pivotal Software, Inc; All rights reserved.**
1. To add up to three footer links that appear to the right of the footer text:
* Click **Add**.
* For **Link text**, enter a label for the link.
* For **Url**, enter an external or relative URL. For example, `http://docs.pivotal.io` or `/tools.html`.
1. For special notification purposes such as governmental or restricted usage, use the **Classification** fields to create a special header and footer:
* For **Classification header and footer background color**, enter the hexadecimal code for the desired background color of the header and footer.
* For **Classification header and footer text color**, enter the hexadecimal code for the desired color of header and footer text.
* For **Classification header content**, enter content for the header in either plain text or HTML. If you enter HTML content, eliminate white spaces and new lines. If you do not provide any content, the custom header will not appear.
* For **Classification footer content**, enter content for the footer in either plain text or HTML. If you enter HTML content, eliminate white spaces and new lines. If you do not provide any content, the custom footer will not appear. The Classification footer appears below the normal footer, which you can customize in the **Footer text** and **Footer links** fields.
<p class="note"><strong>Note:</strong> The header and footer do not appear on the UAA login page.</p>
## <a id='apps-man'></a> Apps Manager Pane
1. In a browser, navigate to the fully qualified domain name (FQDN) of your Ops Manager and log in.
1. Click **Pivotal Application Service**.
1. Click **Apps Manager**.
<%= image_tag 'config-apps-man.png' %>
1. For **Product name**, enter text to replace **Apps Manager** in the header and the title of Apps Manager. This text defaults to **Apps Manager** if left blank.
1. For **Marketplace name**, enter text to replace the header in the Marketplace pages. This text defaults to **Marketplace** if left blank.
1. By default, Apps Manager includes three sidebar links: **Marketplace**, **Docs**, and **Tools**. You can edit existing sidebar links by clicking the name of the link and editing the **Link text** and **URL** fields. You can also remove the link by clicking the trash icon next to its name. If you want to add a new sidebar link, click **Add** and complete the **Link text** and **URL** fields.
<p class="note"><strong>Note:</strong> Removing any of the default links will remove them from the sidebar for all users.</p>
1. (Optional) Enter in MB your desired **Apps Manager memory usage**. The minimum number you can enter is `128`. Leave this field blank to use the default value of 128 MB.
1. (Optional) Enter in MB your desired **Invitations memory usage**. This is the memory limit used to deploy the Invitations app. The minimum number you can enter is `256`. Leave this field blank to use the default value of 256 MB.
1. The **Apps Manager polling interval** field provides a temporary fix if Apps Manager usage degrades Cloud Controller response times. In this case, you can use this field to reduce the load on the Cloud Controller and ensure Apps Manager remains available while you troubleshoot the Cloud Controller. Pivotal recommends that you do not keep this field modified as a long-term fix because it can degrade Apps Manager performance. Optionally, you can:
* Increase the polling interval above the default of 30 seconds.
<p class="note"><strong>Note:</strong> If you enter a value between <code>0</code> and <code>30</code>, the field is automatically set to <code>30</code>.</p>
* Disable polling by entering `0`. This stops Apps Manager from refreshing data automatically, but users can update displayed data by reloading Apps Manager manually.
1. The **App details polling interval** field provides an additional way to reduce the load on the Cloud Controller when the **Apps Manager polling interval** field is not sufficient. This field controls the rate at which Apps Manager polls for data when a user views the **Overview** page of an app. Pivotal recommends that you do not keep this field modified as a long-term fix because it can degrade Apps Manager performance. Optionally, you can:
* Increase the polling interval above the default of 10 seconds.
<p class="note"><strong>Note:</strong> If you enter a value between <code>0</code> and <code>30</code>, the field is automatically set to <code>10</code>.</p>
* Disable polling by entering `0`. This stops Apps Manager from refreshing data automatically, but users can update displayed data by reloading Apps Manager manually.