nprasad2077/docs
1
1
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-09-17 19:55:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Customizing Gitea: add "nonce" to script tags (#520)

Browse Source 
Reviewed-on: https://gitea.com/gitea/docs/pulls/520
Reviewed-by: silverwind <[email protected]>
This commit is contained in:
wxiaoguang
2026-08-20 07:56:43 +00:00
parent 9a34857df9
commit d0a42af7ff
2 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/administration/customizing-gitea.md
+10 -8
View File
@@ -85,6 +85,8 @@ To obtain any embedded file (including templates), the [`gitea embedded` tool](.
Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
shouldn't be touched without fully understanding these components. shouldn't be touched without fully understanding these components.
Gitea pages are protected by Content-Security-Policy, use `<script nonce="{{ctx.CspScriptNonce}}">...</script>` for script tags.
### Customizing startpage / homepage ### Customizing startpage / homepage
Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/main/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`. Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/main/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`.
@@ -139,7 +141,7 @@ copy JavaScript files from https://gitea.com/davidsvantesson/plantuml-code-highl
`$GITEA_CUSTOM/public/assets/` folder. Then add the following to `$GITEA_CUSTOM/templates/custom/footer.tmpl`: `$GITEA_CUSTOM/public/assets/` folder. Then add the following to `$GITEA_CUSTOM/templates/custom/footer.tmpl`:
```html ```html
<script> <script nonce="{{ctx.CspScriptNonce}}">
$(async () => { $(async () => {
if (!$('.language-plantuml').length) return; if (!$('.language-plantuml').length) return;
await Promise.all([ await Promise.all([
@@ -185,18 +187,18 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
``` ```
```html ```html
<script> <script nonce="{{ctx.CspScriptNonce}}">
function onPageChange() { function onPageChange() {
// Supported 3D file types // Supported 3D file types
const fileTypes = ['3dm', '3ds', '3mf', 'amf', 'bim', 'brep', 'dae', 'fbx', 'fcstd', 'glb', 'gltf', 'ifc', 'igs', 'iges', 'stp', 'step', 'stl', 'obj', 'off', 'ply', 'wrl']; const fileTypes = ['3dm', '3ds', '3mf', 'amf', 'bim', 'brep', 'dae', 'fbx', 'fcstd', 'glb', 'gltf', 'ifc', 'igs', 'iges', 'stp', 'step', 'stl', 'obj', 'off', 'ply', 'wrl'];
// Select matching link // Select matching link
const links = Array.from(document.querySelectorAll('a.ui.mini.basic.button')); const links = Array.from(document.querySelectorAll('a.ui.mini.basic.button'));
const link3D = links.find(link => { const link3D = links.find(link => {
const href = link.href.toLowerCase(); const href = link.href.toLowerCase();
return href.includes('/raw/') && fileTypes.some(ext => href.endsWith(`.${ext}`)); return href.includes('/raw/') && fileTypes.some(ext => href.endsWith(`.${ext}`));
}); });
if (link3D) { if (link3D) {
const existingScript = document.querySelector('script[src="/assets/o3dv/o3dv.min.js"]'); const existingScript = document.querySelector('script[src="/assets/o3dv/o3dv.min.js"]');
@@ -226,11 +228,11 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
newView3D.style.flexGrow = '1'; newView3D.style.flexGrow = '1';
newView3D.style.minHeight = '0'; newView3D.style.minHeight = '0';
newView3D.style.width = '100%'; newView3D.style.width = '100%';
const header = document.querySelector('header'); const header = document.querySelector('header');
const headerHeight = header ? header.offsetHeight : 0; const headerHeight = header ? header.offsetHeight : 0;
newView3D.style.height = `calc(100vh - ${headerHeight}px)`; newView3D.style.height = `calc(100vh - ${headerHeight}px)`;
// Append the new container inside fileView // Append the new container inside fileView
fileView.appendChild(newView3D); fileView.appendChild(newView3D);
@@ -273,7 +275,7 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
}; };
// Run when the page is fully loaded // Run when the page is fully loaded
document.addEventListener('DOMContentLoaded', onPageChange); document.addEventListener('DOMContentLoaded', onPageChange);
const targetSelector = 'a.ui.mini.basic.button[href*="/raw/"]'; const targetSelector = 'a.ui.mini.basic.button[href*="/raw/"]';
let lastHref = null; let lastHref = null;
@@ -289,7 +291,7 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
const fileName = currentHref.split('/').pop(); const fileName = currentHref.split('/').pop();
console.log('New Raw file link detected after delay:', fileName); console.log('New Raw file link detected after delay:', fileName);
onPageChange(); onPageChange();
} }
}; };
versioned_docs/version-1.27/administration/customizing-gitea.md
+10 -8
View File
@@ -85,6 +85,8 @@ To obtain any embedded file (including templates), the [`gitea embedded` tool](.
Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
shouldn't be touched without fully understanding these components. shouldn't be touched without fully understanding these components.
Gitea pages are protected by Content-Security-Policy, use `<script nonce="{{ctx.CspScriptNonce}}">...</script>` for script tags.
### Customizing startpage / homepage ### Customizing startpage / homepage
Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/main/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`. Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/main/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`.
@@ -139,7 +141,7 @@ copy JavaScript files from https://gitea.com/davidsvantesson/plantuml-code-highl
`$GITEA_CUSTOM/public/assets/` folder. Then add the following to `$GITEA_CUSTOM/templates/custom/footer.tmpl`: `$GITEA_CUSTOM/public/assets/` folder. Then add the following to `$GITEA_CUSTOM/templates/custom/footer.tmpl`:
```html ```html
<script> <script nonce="{{ctx.CspScriptNonce}}">
$(async () => { $(async () => {
if (!$('.language-plantuml').length) return; if (!$('.language-plantuml').length) return;
await Promise.all([ await Promise.all([
@@ -185,18 +187,18 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
``` ```
```html ```html
<script> <script nonce="{{ctx.CspScriptNonce}}">
function onPageChange() { function onPageChange() {
// Supported 3D file types // Supported 3D file types
const fileTypes = ['3dm', '3ds', '3mf', 'amf', 'bim', 'brep', 'dae', 'fbx', 'fcstd', 'glb', 'gltf', 'ifc', 'igs', 'iges', 'stp', 'step', 'stl', 'obj', 'off', 'ply', 'wrl']; const fileTypes = ['3dm', '3ds', '3mf', 'amf', 'bim', 'brep', 'dae', 'fbx', 'fcstd', 'glb', 'gltf', 'ifc', 'igs', 'iges', 'stp', 'step', 'stl', 'obj', 'off', 'ply', 'wrl'];
// Select matching link // Select matching link
const links = Array.from(document.querySelectorAll('a.ui.mini.basic.button')); const links = Array.from(document.querySelectorAll('a.ui.mini.basic.button'));
const link3D = links.find(link => { const link3D = links.find(link => {
const href = link.href.toLowerCase(); const href = link.href.toLowerCase();
return href.includes('/raw/') && fileTypes.some(ext => href.endsWith(`.${ext}`)); return href.includes('/raw/') && fileTypes.some(ext => href.endsWith(`.${ext}`));
}); });
if (link3D) { if (link3D) {
const existingScript = document.querySelector('script[src="/assets/o3dv/o3dv.min.js"]'); const existingScript = document.querySelector('script[src="/assets/o3dv/o3dv.min.js"]');
@@ -226,11 +228,11 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
newView3D.style.flexGrow = '1'; newView3D.style.flexGrow = '1';
newView3D.style.minHeight = '0'; newView3D.style.minHeight = '0';
newView3D.style.width = '100%'; newView3D.style.width = '100%';
const header = document.querySelector('header'); const header = document.querySelector('header');
const headerHeight = header ? header.offsetHeight : 0; const headerHeight = header ? header.offsetHeight : 0;
newView3D.style.height = `calc(100vh - ${headerHeight}px)`; newView3D.style.height = `calc(100vh - ${headerHeight}px)`;
// Append the new container inside fileView // Append the new container inside fileView
fileView.appendChild(newView3D); fileView.appendChild(newView3D);
@@ -273,7 +275,7 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
}; };
// Run when the page is fully loaded // Run when the page is fully loaded
document.addEventListener('DOMContentLoaded', onPageChange); document.addEventListener('DOMContentLoaded', onPageChange);
const targetSelector = 'a.ui.mini.basic.button[href*="/raw/"]'; const targetSelector = 'a.ui.mini.basic.button[href*="/raw/"]';
let lastHref = null; let lastHref = null;
@@ -289,7 +291,7 @@ nano $GITEA_CUSTOM/templates/custom/footer.tmpl
const fileName = currentHref.split('/').pop(); const fileName = currentHref.split('/').pop();
console.log('New Raw file link detected after delay:', fileName); console.log('New Raw file link detected after delay:', fileName);
onPageChange(); onPageChange();
} }
}; };