Skip to content

Commit dd7c67f

Browse files
committed
Re-write documentation to use new template_file
1 parent 074a774 commit dd7c67f

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

docs/source/customizing.rst

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,30 @@ To add a custom header and footer,
2626
</body>
2727

2828
It is important to include ``<div id="root"></div>`` because this is the HTML node that React will use to build the launch form.
29-
3. add a `ConfigMap <https://kubernetes.io/docs/concepts/configuration/configmap/>`_ to your Helm configuration.
29+
3. copy ``files/custom-page.html`` into ``extraFiles`` in the Helm configuration file.
3030
For example::
3131

32-
kind: ConfigMap
33-
apiVersion: v1
34-
metadata:
35-
name: binderhub-template-custom
36-
labels:
37-
app: binder
38-
component: etc-binderhub
39-
heritage: {{ .Release.Service }}
40-
release: {{ .Release.Name }}
41-
data:
42-
{{- (.Files.Glob "files/*").AsConfig | nindent 2 }}
43-
4. add
32+
extraFiles:
33+
custom-page:
34+
mountPath: files/custom-page.html
35+
stringData: |
36+
...
37+
<body>
38+
<header>
39+
My Own BinderHub
40+
</header>
41+
<div id="root"></div>
42+
<footer>
43+
Powered by BinderHub
44+
</footer>
45+
</body>
46+
...
47+
4. change ``template_file`` in the Helm configuration file.
48+
For example::
49+
50+
config:
51+
BinderHub:
52+
template_file: files/custom-page.html
4453

4554
Banner customization
4655
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)