Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-12-18 20:26:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
f71015efec4aff9cabaa0b335839ca2a7e37ac1d
wg-portal/master/documentation/usage/mail-templates/index.html

8 lines
22 KiB
HTML
Raw Normal View History

Deployed 8cc937b to master with MkDocs 1.6.1 and mike 2.1.3
2025-12-10 22:11:26 +00:00
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><link href=https://wgportal.org/master/documentation/usage/mail-templates/ rel=canonical><link href=../webhooks/ rel=prev><link href=../../rest-api/api-doc/ rel=next><link rel=icon href=../../../assets/images/favicon-large.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.0"><title>Mail Templates - WireGuard Portal</title><link rel=stylesheet href=../../../assets/stylesheets/main.618322db.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=stylesheet href=../../../stylesheets/extra.css><link rel=stylesheet href=../../../stylesheets/img-comparison-slider.css><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta property=og:type content=website><meta property=og:title content="Mail Templates - WireGuard Portal"><meta property=og:description content="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><meta property=og:image content=https://wgportal.org/master/assets/images/social/documentation/usage/mail-templates.png><meta property=og:image:type content=image/png><meta property=og:image:width content=1200><meta property=og:image:height content=630><meta content=https://wgportal.org/master/documentation/usage/mail-templates/ property=og:url><meta property=twitter:card content=summary_large_image><meta property=twitter:title content="Mail Templates - WireGuard Portal"><meta property=twitter:description content="Manage WireGuard Peers and Interface using a beautiful and simple web UI."><meta property=twitter:image content=https://wgportal.org/master/assets/images/social/documentation/usage/mail-templates.png></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=white data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#configuration class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title="WireGuard Portal" class="md-header__button md-logo" aria-label="WireGuard Portal" data-md-component=logo> <img src=../../../assets/images/logo.svg alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> WireGuard Portal </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Mail Templates </span> </div> </div> </div> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off auto
<span class=w> </span><span class=c1># ... other mail options ...</span>
<span class=w> </span><span class=c1># Path where custom email templates (.gotpl and .gohtml) are stored.</span>
<span class=w> </span><span class=c1># If the directory is empty on startup, the default embedded templates</span>
<span class=w> </span><span class=c1># will be written there so you can modify them.</span>
<span class=w> </span><span class=c1># Leave empty to use embedded templates only.</span>
<span class=w> </span><span class=nt>templates_path</span><span class=p>:</span><span class=w> </span><span class=s>&quot;/opt/wg-portal/mail-templates&quot;</span>
</code></pre></div> <h2 id=template-files-and-names>Template files and names</h2> <p>The system expects the following template names. Place files with these names in your <code>templates_path</code> to override the defaults. You do not need to override all templates, only the ones you want to customize should be present.</p> <ul> <li>Text templates (<code>.gotpl</code>):</li> <li><code>mail_with_link.gotpl</code></li> <li><code>mail_with_attachment.gotpl</code></li> <li>HTML templates (<code>.gohtml</code>):</li> <li><code>mail_with_link.gohtml</code></li> <li><code>mail_with_attachment.gohtml</code></li> </ul> <p>Both <a href=https://pkg.go.dev/text/template>text</a> and <a href=https://pkg.go.dev/html/template>HTML templates</a> are standard Go templates and receive the following data fields, depending on the email type:</p> <ul> <li>Common fields:</li> <li><code>PortalUrl</code> (string) - external URL of the Portal</li> <li><code>PortalName</code> (string) - site title/company name</li> <li><code>User</code> (*domain.User) - the recipient user (may be partially populated when sending to a peer email)</li> <li>Link email (<code>mail_with_link.*</code>):</li> <li><code>Link</code> (string) - the download link</li> <li>Attachment email (<code>mail_with_attachment.*</code>):</li> <li><code>ConfigFileName</code> (string) - filename of the attached WireGuard config</li> <li><code>QrcodePngName</code> (string) - CID content-id of the embedded QR code image</li> </ul> <p>Tip: You can inspect the embedded templates in the repository under <a href=https://github.com/h44z/wg-portal/tree/master/internal/app/mail/tpl_files><code>internal/app/mail/tpl_files/</code></a> for reference. When the directory at <code>templates_path</code> is empty, these files are copied to your folder so you can edit them in place.</p> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <!-- Application footer --> <footer class=md-footer> <!-- Further information --> <div class="md-footer-meta md-typeset" style="background-color: #fff;"> <div class="md-footer-meta__inner md-grid" style="background-color: #fff;"> <!-- Copyright and theme information --> <div class=md-footer-copyright> <div class=md-footer-copyright__highlight style="color: rgb(38, 38, 38);"> Copyright &copy; 2023-2025 WireGuard Portal Project </div> <div style="color: rgb(38, 38, 38);"> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener style="color: black;"> Material for MkDocs </a> </div> </div> <!-- Social links --> <div class=md-social> <a href=https://github.com/h44z/wg-portal target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M202.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1M496 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2m-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3m-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1"/></svg> </a> <a href=https://hub.docker.com/r/wgportal/wg-portal target=_blank rel=noopener title=hub.docker.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 640 512"><!-- Font Awesome Free 7
Reference in New Issue Copy Permalink