Documentation
¶
Index ¶
- Variables
- type StaticAsset
- type StaticAssetLibrary
- type UserInterfaceArgs
- type UserInterfaceFactory
- func (f *UserInterfaceFactory) AddBuiltinTemplate(name string) error
- func (f *UserInterfaceFactory) AddBuiltinTemplates() error
- func (f *UserInterfaceFactory) AddTemplate(s, tp string) error
- func (f *UserInterfaceFactory) DeleteTemplates()
- func (f *UserInterfaceFactory) GetArgs() *UserInterfaceArgs
- func (f *UserInterfaceFactory) Render(name string, args *UserInterfaceArgs) (*bytes.Buffer, error)
- type UserInterfaceLink
- type UserInterfaceParameters
- type UserInterfaceTemplate
- type UserRealm
Constants ¶
This section is empty.
Variables ¶
View Source
var PageTemplates = map[string]string{
"basic/login": `<!doctype html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="Authentication Portal">
<meta name="author" content="Paul Greenberg github.com/greenpau">
<link rel="shortcut icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<link rel="icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<!-- Matrialize CSS -->
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/materialize-css/css/materialize.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/google-webfonts/roboto.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/line-awesome/line-awesome.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/styles.css" }}" />
{{ if eq .Data.ui_options.custom_css_required "yes" }}
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/custom.css" }}" />
{{ end }}
</head>
<body class="app-body">
<div class="container">
<div class="row">
<div class="col s12 m8 offset-m2 l6 offset-l3 xl4 offset-xl4 app-card-container">
<div class="row app-header center">
{{ if .LogoURL }}
<div class="col s4">
<img class="d-block mx-auto mb-2" src="{{ .LogoURL }}" alt="{{ .LogoDescription }}" width="72" height="72">
</div>
<div class="col s8">
<h4>{{ .Title }}</h4>
</div>
{{ else }}
<h4>{{ .Title }}</h4>
{{ end }}
</div>
{{ if eq .Data.login_options.form_required "yes" }}
<form action="{{ .ActionEndpoint }}" method="POST">
<div class="row app-form">
{{ if eq .Data.login_options.username_required "yes" }}
<div class="row app-input-row valign-wrapper">
<div class="col s4">
<p class="app-input-text">Username</p>
</div>
<div class="col s8">
<div class="input-field app-input-field">
<input id="username" name="username" type="text" class="validate">
</div>
</div>
</div>
{{ end }}
{{ if eq .Data.login_options.password_required "yes" }}
<div class="row app-input-row valign-wrapper">
<div class="col s4">
<p class="app-input-text">Password</p>
</div>
<div class="col s8">
<div class="input-field app-input-field">
<input id="password" name="password" type="password" class="validate">
</div>
</div>
</div>
{{ end }}
{{ if eq .Data.login_options.realm_dropdown_required "yes" }}
<div class="row app-input-row valign-wrapper">
<div class="col s4">
<p class="app-input-text">Domain</p>
</div>
<div class="col s8">
<div class="input-field app-input-field">
<select id="realm" name="realm" class="browser-default">
{{ range .Data.login_options.realms }}
{{ if eq .default "yes" }}
<option value="{{ .realm }}" selected>{{ .label }}</option>
{{ else }}
<option value="{{ .realm }}">{{ .label }}</option>
{{ end }}
{{ end }}
</select>
</div>
</div>
</div>
{{ else }}
{{ range .Data.login_options.realms }}
<input type="hidden" id="realm" name="realm" value="{{ .realm }}" />
{{ end }}
{{ end }}
</div>
<div class="row app-control valign-wrapper">
<div class="col s6">
{{ if eq .Data.login_options.registration_required "yes" }}
<span class="app-link"><a href="{{ pathjoin .ActionEndpoint "/register" }}">Register</a></span>
{{ end }}
{{ if eq .Data.login_options.password_recovery_required "yes" }}
<span class="app-link"><a href="{{ pathjoin .ActionEndpoint "/forgot" }}">Forgot Password?</a></span>
{{ end }}
</div>
<div class="col s6 right-align">
<button type="submit" name="submit" class="waves-effect waves-light btn app-btn">
<i class="las la-sign-in-alt left app-btn-icon"></i>
<span class="app-btn-text">Login</span>
</button>
</div>
</div>
</form>
{{ end }}
{{ if eq .Data.login_options.external_providers_required "yes" }}
<div class="row">
{{ if eq .Data.login_options.username_required "yes" }}
<p class="app-text">Additional Sign In Options:</p>
{{end}}
{{ range .Data.login_options.external_providers }}
<a class="waves-effect waves-light {{ .color }} app-btn btn" href="{{ .endpoint }}">
<i class="lab la-{{ .icon }} app-btn-icon"></i><span class="app-btn-text">{{ .text }}</span>
</a>
{{ end }}
</div>
{{ end }}
</div>
</div>
</div>
<!-- Optional JavaScript -->
<script src="{{ pathjoin .ActionEndpoint "/assets/materialize-css/js/materialize.js" }}"></script>
{{ if eq .Data.ui_options.custom_js_required "yes" }}
<script src="{{ pathjoin .ActionEndpoint "/assets/js/custom.js" }}"></script>
{{ end }}
{{ if .Message }}
<script>
var toastHTML = '<span class="app-error-text">{{ .Message }}</span><button class="btn-flat toast-action" onclick="M.Toast.dismissAll();">Close</button>';
toastElement = M.toast({
html: toastHTML,
classes: 'toast-error'
});
const appContainer = document.querySelector('.app-card-container')
appContainer.prepend(toastElement.el)
</script>
{{ end }}
</body>
</html>`,
"basic/portal": `<!doctype html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="Authentication Portal">
<meta name="author" content="Paul Greenberg github.com/greenpau">
<link rel="shortcut icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<link rel="icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<!-- Matrialize CSS -->
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/materialize-css/css/materialize.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/google-webfonts/roboto.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/line-awesome/line-awesome.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/styles.css" }}" />
{{ if eq .Data.ui_options.custom_css_required "yes" }}
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/custom.css" }}" />
{{ end }}
</head>
<body class="app-body">
<div class="container">
<div class="row">
<div class="col s12 m6 offset-m3 l4 offset-l4 app-card-container">
<div class="row app-header center">
{{ if .LogoURL }}
<div class="col">
<img class="d-block mx-auto mb-2" src="{{ .LogoURL }}" alt="{{ .LogoDescription }}" width="72" height="72">
</div>
<div class="col">
<h4>{{ .Title }}</h4>
</div>
{{ else }}
<h4>{{ .Title }}</h4>
{{ end }}
</div>
<div class="row">
<p class="app-text">Access the following services.</p>
<ul class="collection">
{{range .PrivateLinks}}
<li class="collection-item">
<a href="{{ .Link }}">{{ .Title }}</a>
</li>
{{ end }}
</ul>
</div>
<div class="row right">
<a href="{{ pathjoin .ActionEndpoint "/logout" }}" class="navbtn-last">
<button type="button" class="waves-effect waves-light btn navbtn active navbtn-last app-btn">
<i class="las la-sign-out-alt left app-btn-icon"></i>
<span class="app-btn-text">Logout</span>
</button>
</a>
</div>
</div>
</div>
</div>
<!-- Optional JavaScript -->
<script src="{{ pathjoin .ActionEndpoint "/assets/materialize-css/js/materialize.js" }}"></script>
{{ if eq .Data.ui_options.custom_js_required "yes" }}
<script src="{{ pathjoin .ActionEndpoint "/assets/js/custom.js" }}"></script>
{{ end }}
{{ if .Message }}
<script>
var toastHTML = '<span>{{ .Message }}</span><button class="btn-flat toast-action" onclick="M.Toast.dismissAll();">Close</button>';
toastElement = M.toast({
html: toastHTML,
classes: 'toast-error'
});
const appContainer = document.querySelector('.app-card-container')
appContainer.prepend(toastElement.el)
</script>
{{ end }}
</body>
</html>`,
"basic/whoami": `<!doctype html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="Authentication Portal">
<meta name="author" content="Paul Greenberg github.com/greenpau">
<link rel="shortcut icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<link rel="icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<!-- Matrialize CSS -->
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/materialize-css/css/materialize.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/google-webfonts/roboto.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/line-awesome/line-awesome.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/highlight.js/css/atom-one-dark.min.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/styles.css" }}" />
{{ if eq .Data.ui_options.custom_css_required "yes" }}
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/custom.css" }}" />
{{ end }}
</head>
<body class="app-body">
<div class="container">
<div class="row">
<div class="col s12 m12 l6 offset-l3 app-card-container">
<div class="row app-header center">
{{ if .LogoURL }}
<div class="col">
<img class="d-block mx-auto mb-2" src="{{ .LogoURL }}" alt="{{ .LogoDescription }}" width="72" height="72">
</div>
<div class="col">
<h4>{{ .Title }}</h4>
</div>
{{ else }}
<h4>{{ .Title }}</h4>
{{ end }}
</div>
<div class="row">
<pre><code class="language-json hljs">{{ .Data.token }}</code></pre>
</div>
<div class="row right">
<a href="{{ pathjoin .ActionEndpoint "/portal" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<i class="las la-home left app-btn-icon"></i>
<span class="app-btn-text">Portal</span>
</button>
</a>
<a href="{{ pathjoin .ActionEndpoint "/logout" }}" class="navbtn-last">
<button type="button" class="btn waves-effect waves-light navbtn active navbtn-last">
<i class="las la-sign-out-alt left app-btn-icon"></i>
<span class="app-btn-text">Logout</span>
</button>
</a>
</div>
</div>
</div>
</div>
<!-- Optional JavaScript -->
<script src="{{ pathjoin .ActionEndpoint "/assets/materialize-css/js/materialize.js" }}"></script>
<script src="{{ pathjoin .ActionEndpoint "/assets/highlight.js/js/highlight.js" }}"></script>
<script src="{{ pathjoin .ActionEndpoint "/assets/highlight.js/js/languages/json.min.js" }}"></script>
{{ if eq .Data.ui_options.custom_js_required "yes" }}
<script src="{{ pathjoin .ActionEndpoint "/assets/js/custom.js" }}"></script>
{{ end }}
<script>
hljs.initHighlightingOnLoad();
</script>
</body>
</html>`,
"basic/register": `<!doctype html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="Authentication Portal">
<meta name="author" content="Paul Greenberg github.com/greenpau">
<link rel="shortcut icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<link rel="icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<!-- Matrialize CSS -->
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/materialize-css/css/materialize.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/google-webfonts/roboto.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/line-awesome/line-awesome.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/styles.css" }}" />
{{ if eq .Data.ui_options.custom_css_required "yes" }}
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/custom.css" }}" />
{{ end }}
</head>
<body class="app-body">
<div class="container">
<div class="row">
<div class="col s12 m12 l6 offset-l3">
{{ if not .Data.registered }}
<form action="{{ pathjoin .ActionEndpoint "/register" }}" method="POST">
{{ end }}
<div class="card card-large app-card">
<div class="card-content">
<span class="card-title center-align">
<div class="section app-header">
{{ if .LogoURL }}
<img class="d-block mx-auto mb-2" src="{{ .LogoURL }}" alt="{{ .LogoDescription }}" width="72" height="72">
{{ end }}
<h4>{{ .Title }}</h4>
</div>
</span>
{{ if not .Data.registered }}
<div class="input-field">
<input id="username" name="username" type="text" class="validate"
pattern="[a-z0-9]{3,25}"
title="Username should contain maximum of 25 characters and consists of a-z and 0-9 characters."
required />
<label for="username">Username</label>
</div>
<div class="input-field">
<input id="email" name="email" type="email" class="validate"
required />
<label for="email">Email Address</label>
</div>
<div class="input-field">
<input id="password" name="password" type="password" class="validate" required />
<label for="password">Password</label>
</div>
<div class="input-field">
<input id="password_confirm" name="password_confirm" type="password" class="validate" required />
<label for="password_confirm">Confirm Password</label>
</div>
{{ if .Data.require_registration_code }}
<div class="input-field">
<input id="code" name="code" type="text" class="validate" required />
<label for="code">Registration Code</label>
</div>
{{ end }}
{{ if .Data.require_accept_terms }}
<p>
<label>
<input type="checkbox" id="accept_terms" name="accept_terms" required />
<span>I agree to
<a href="{{ pathjoin .ActionEndpoint "/termsandconditions" }}">Terms and Conditions</a> and
<a href="{{ pathjoin .ActionEndpoint "/privacypolicy" }}">Privacy Policy</a>.
</span>
</label>
</p>
{{ end }}
{{ else }}
<p class="app-text">Thank you for registering and we hope you enjoy the experience!</p>
<p class="app-text">Here are a few things to keep in mind:</p>
<ol class="app-text">
<li>You should receive your confirmation email within the next 15 minutes.</li>
<li>If you still don't see it, please email support so we can resend it to you.</li>
</ol>
{{ end }}
</div>
<div class="card-action right-align">
{{ if not .Data.registered }}
<a href="{{ .ActionEndpoint }}" class="navbtn-last">
<button type="button" class="waves-effect waves-light btn navbtn active navbtn-last app-btn">
<i class="las la-undo left app-btn-icon"></i>
<span class="app-btn-text">Back</span>
</button>
</a>
<button type="submit" name="submit" class="waves-effect waves-light btn navbtn active navbtn-last app-btn">
<i class="las la-chevron-circle-right app-btn-icon"></i>
<span class="app-btn-text">Submit</span>
</button>
{{ else }}
<a href="{{ .ActionEndpoint }}" class="navbtn-last">
<button type="button" class="waves-effect waves-light btn navbtn active navbtn-last app-btn">
<i class="las la-home left app-btn-icon"></i>
<span class="app-btn-text">Portal</span>
</button>
</a>
{{ end }}
</div>
</div>
</form>
</div>
</div>
</div>
<!-- Optional JavaScript -->
<script src="{{ pathjoin .ActionEndpoint "/assets/materialize-css/js/materialize.js" }}"></script>
{{ if eq .Data.ui_options.custom_js_required "yes" }}
<script src="{{ pathjoin .ActionEndpoint "/assets/js/custom.js" }}"></script>
{{ end }}
{{ if .Message }}
<script>
var toastHTML = '<span>{{ .Message }}</span><button class="btn-flat toast-action" onclick="M.Toast.dismissAll();">Close</button>';
toastElement = M.toast({
html: toastHTML,
classes: 'toast-error'
});
const appContainer = document.querySelector('.app-card-container')
appContainer.prepend(toastElement.el)
</script>
{{ end }}
</body>
</html>`,
"basic/generic": `<!doctype html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="Authentication Portal">
<meta name="author" content="Paul Greenberg github.com/greenpau">
<link rel="shortcut icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<link rel="icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<!-- Matrialize CSS -->
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/materialize-css/css/materialize.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/google-webfonts/roboto.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/line-awesome/line-awesome.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/styles.css" }}" />
{{ if eq .Data.ui_options.custom_css_required "yes" }}
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/custom.css" }}" />
{{ end }}
</head>
<body class="app-body">
<div class="container">
<div class="row">
<div class="col s12 m12 l6 offset-l3">
<div class="card card-large app-card">
<div class="card-content">
<span class="card-title center-align">
<div class="section app-header">
{{ if .LogoURL }}
<img class="d-block mx-auto mb-2" src="{{ .LogoURL }}" alt="{{ .LogoDescription }}" width="72" height="72">
{{ end }}
<h4>{{ .Title }}</h4>
</div>
</span>
</div>
<div class="card-action right-align">
{{ if .Data.go_back_url }}
<a href="{{ .Data.go_back_url }}" class="navbtn-last">
<button type="button" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-undo left app-btn-icon"></i>
<span class="app-btn-text">Go Back</span>
</button>
</a>
{{ end }}
</div>
</div>
</div>
</div>
</div>
<!-- Optional JavaScript -->
<script src="{{ pathjoin .ActionEndpoint "/assets/materialize-css/js/materialize.js" }}"></script>
{{ if eq .Data.ui_options.custom_js_required "yes" }}
<script src="{{ pathjoin .ActionEndpoint "/assets/js/custom.js" }}"></script>
{{ end }}
</body>
</html>`,
"basic/settings": `<!doctype html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="Authentication Portal">
<meta name="author" content="Paul Greenberg github.com/greenpau">
<link rel="shortcut icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<link rel="icon" href="{{ pathjoin .ActionEndpoint "/assets/images/favicon.png" }}" type="image/png">
<!-- Matrialize CSS -->
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/materialize-css/css/materialize.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/google-webfonts/roboto.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/line-awesome/line-awesome.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/highlight.js/css/atom-one-dark.min.css" }}" />
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/styles.css" }}" />
{{ if eq .Data.ui_options.custom_css_required "yes" }}
<link rel="stylesheet" href="{{ pathjoin .ActionEndpoint "/assets/css/custom.css" }}" />
{{ end }}
</head>
<body class="app-body">
<div class="container app-container">
<div class="row">
<nav>
<div class="nav-wrapper">
{{ if .LogoURL }}
<img src="{{ .LogoURL }}" alt="{{ .LogoDescription }}" />
{{ end }}
<a href="#" class="brand-logo">{{ .Title }}</a>
<ul id="nav-mobile" class="right hide-on-med-and-down">
<li>
<a href="{{ pathjoin .ActionEndpoint "/portal" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<span class="app-btn-text">Portal</span>
<i class="las la-home left app-btn-icon app-navbar-btn-icon"></i>
</button>
</a>
</li>
<li>
<a href="{{ pathjoin .ActionEndpoint "/logout" }}" class="navbtn-last">
<button type="button" class="btn waves-effect waves-light navbtn active navbtn-last">
<span class="app-btn-text">Logout</span>
<i class="las la-sign-out-alt left app-btn-icon app-navbar-btn-icon"></i>
</button>
</a>
</li>
</ul>
</div>
</nav>
</div>
<div class="row">
<div class="col s12 l3">
<div class="collection">
<a href="{{ pathjoin .ActionEndpoint "/settings/" }}" class="collection-item{{ if eq .Data.view "general" }} active{{ end }}">General</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/sshkeys" }}" class="collection-item{{ if eq .Data.view "sshkeys" }} active{{ end }}">SSH Keys</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/gpgkeys" }}" class="collection-item{{ if eq .Data.view "gpgkeys" }} active{{ end }}">GPG Keys</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/apikeys" }}" class="collection-item{{ if eq .Data.view "apikeys" }} active{{ end }}">API Keys</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/mfa" }}" class="collection-item{{ if eq .Data.view "mfa" }} active{{ end }}">MFA</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/password" }}" class="collection-item{{ if eq .Data.view "password" }} active{{ end }}">Password</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/misc" }}" class="collection-item{{ if eq .Data.view "misc" }} active{{ end }}">Miscellaneous</a>
<a href="{{ pathjoin .ActionEndpoint "/portal" }}" class="hide-on-med-and-up collection-item">Portal</a>
<a href="{{ pathjoin .ActionEndpoint "/logout" }}" class="hide-on-med-and-up collection-item">Logout</a>
</div>
</div>
<div class="col s12 l9 app-content">
{{ if eq .Data.view "general" }}
<p>The {{ .Data.view }} view is under construction.</p>
{{ end }}
{{ if eq .Data.view "sshkeys" }}
<div class="row">
<div class="col s12 right">
<a href="{{ pathjoin .ActionEndpoint "/settings/sshkeys/add" }}">
<button type="button" class="btn waves-effect waves-light navbtn active app-btn">
<i class="las la-key left app-btn-icon"></i>
<span class="app-btn-text">Add SSH Key</span>
</button>
</a>
</div>
</div>
<div class="row">
{{ if .Data.ssh_keys }}
<p>List of registered SSH Keys</p>
{{ else }}
<p>No registered SSH Keys found</p>
{{ end }}
</div>
{{ end }}
{{ if eq .Data.view "sshkeys-add" }}
<form action="{{ pathjoin .ActionEndpoint "/settings/sshkeys/add" }}" method="POST">
<div class="row">
<div class="col s12">
<h1>Add SSH Key</h1>
<p>Please paste your public SSH key here.</p>
<div class="input-field shell-textarea-wrapper">
<textarea id="key1" name="key1" class="hljs shell-textarea"></textarea>
</div>
<div class="right">
<button type="submit" name="submit" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-plus-circle left app-btn-icon"></i>
<span class="app-btn-text">Add SSH Key</span>
</button>
</div>
</div>
</div>
</form>
{{ end }}
{{ if eq .Data.view "sshkeys-add-status" }}
{{ if eq .Data.status "success" }}
<h1>Public SSH Key Has Been Added</h1>
<p>{{ .Data.status_reason }}</p>
<a href="{{ pathjoin .ActionEndpoint "/settings/sshkeys" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<i class="las la-undo-alt left app-btn-icon"></i>
<span class="app-btn-text">Go Back</span>
</button>
</a>
{{ else }}
<h1>Failed Adding Public SSH Key</h1>
<p>Reason: {{ .Data.status_reason }} </p>
<a href="{{ pathjoin .ActionEndpoint "/settings/sshkeys/add" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<i class="las la-undo-alt left app-btn-icon"></i>
<span class="app-btn-text">Try Again</span>
</button>
</a>
{{ end }}
{{ end }}
{{ if eq .Data.view "gpgkeys" }}
<div class="row">
<div class="col s12 right">
<a href="{{ pathjoin .ActionEndpoint "/settings/gpgkeys/add" }}">
<button type="button" class="btn waves-effect waves-light navbtn active app-btn">
<i class="las la-key left app-btn-icon"></i>
<span class="app-btn-text">Add GPG Key</span>
</button>
</a>
</div>
</div>
<div class="row">
{{ if .Data.gpg_keys }}
<p>List of registered GPG Keys</p>
{{ else }}
<p>No registered GPG Keys found</p>
{{ end }}
</div>
{{ end }}
{{ if eq .Data.view "gpgkeys-add" }}
<form action="{{ pathjoin .ActionEndpoint "/settings/gpgkeys/add" }}" method="POST">
<div class="row">
<div class="col s12">
<h1>Add GPG Key</h1>
<p>Please paste your public GPG key here.</p>
<div class="input-field shell-textarea-wrapper">
<textarea id="key1" name="key1" class="hljs shell-textarea"></textarea>
</div>
<div class="right">
<button type="submit" name="submit" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-plus-circle left app-btn-icon"></i>
<span class="app-btn-text">Add GPG Key</span>
</button>
</div>
</div>
</div>
</form>
{{ end }}
{{ if eq .Data.view "gpgkeys-add-status" }}
{{ if eq .Data.status "success" }}
<h1>Public GPG Key Has Been Added</h1>
<p>{{ .Data.status_reason }}</p>
<a href="{{ pathjoin .ActionEndpoint "/settings/gpgkeys" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<i class="las la-undo-alt left app-btn-icon"></i>
<span class="app-btn-text">Go Back</span>
</button>
</a>
{{ else }}
<h1>Failed Adding Public GPG Key</h1>
<p>Reason: {{ .Data.status_reason }} </p>
<a href="{{ pathjoin .ActionEndpoint "/settings/gpgkeys/add" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<i class="las la-undo-alt left app-btn-icon"></i>
<span class="app-btn-text">Try Again</span>
</button>
</a>
{{ end }}
{{ end }}
{{ if eq .Data.view "apikeys" }}
<div class="row">
<div class="col s12">
<a href="{{ pathjoin .ActionEndpoint "/settings/apikeys/add" }}">
<button type="button" class="btn waves-effect waves-light navbtn active app-btn">
<i class="las la-key left app-btn-icon"></i>
<span class="app-btn-text">Add API Key</span>
</button>
</a>
</div>
</div>
<div class="row">
{{ if .Data.api_keys }}
<p>List of registered API Keys</p>
{{ else }}
<p>No registered API Keys found</p>
{{ end }}
</div>
{{ end }}
{{ if eq .Data.view "mfa" }}
<div class="row">
<div class="col 12 right">
<a href="{{ pathjoin .ActionEndpoint "/settings/mfa/add/app" }}">
<button type="button" class="btn waves-effect waves-light navbtn active app-btn">
<i class="las la-mobile-alt left app-btn-icon"></i>
<span class="app-btn-text">Add MFA App</span>
</button>
</a>
<a href="{{ pathjoin .ActionEndpoint "/settings/mfa/add/u2f" }}" class="navbtn-last">
<button type="button" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-key left app-btn-icon"></i>
<span class="app-btn-text">Add U2F Key</span>
</button>
</a>
</div>
</div>
<div class="row">
{{ if .Data.mfa_devices }}
<p>List of registered MFA devices</p>
{{ else }}
<p>No registered MFA devices found</p>
{{ end }}
</div>
{{ end }}
{{ if eq .Data.view "mfa-add-app" }}
<form action="{{ pathjoin .ActionEndpoint "/settings/mfa/add/app" }}" method="POST">
<div class="row">
<h1>Add MFA Authenticator Application</h1>
<div class="row">
<div class="col s12 m6 l6">
<p>Please add your MFA authenticator application, e.g. Microsoft/Google Authenticator, Authy, etc.</p>
<p>If your MFA application supports scanning QR codes, scan the QR code image.</p>
<p>After adding this account to the MFA authenticator application, enter two consecutive authentication codes in the boxes below and click "Add".</p>
<div class="input-field">
<input id="mfacode1" name="mfacode1" type="text" class="validate" pattern="[A-Za-z0-9]{4,8}"
title="Authentication code should contain maximum of 25 characters and consists of A-Z, a-z, and 0-9 characters."
required />
<label for="mfacode1">Authentication Code 1</label>
</div>
<div class="input-field">
<input id="mfacode2" name="mfacode2" type="text" class="validate" pattern="[A-Za-z0-9]{4,8}"
title="Authentication code should contain maximum of 25 characters and consists of A-Z, a-z, and 0-9 characters."
required />
<label for="mfacode2">Authentication Code 2</label>
</div>
</div>
<div class="col s12 m6 l6">
<div class="center-align"><img src="{{ pathjoin .ActionEndpoint "/settings/mfa/barcode/" .Data.code_uri_encoded }}.png" alt="QR Code" /></div>
<div class="center-align"><a href="{{ .Data.code_uri }}">Link</a></div>
</div>
</div>
</div>
<div class="row right">
<button type="submit" name="submit" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-plus-circle left app-btn-icon"></i>
<span class="app-btn-text">Add Token</span>
</button>
</div>
</form>
{{ end }}
{{ if eq .Data.view "mfa-add-u2f" }}
<form action="{{ pathjoin .ActionEndpoint "/settings/mfa/add/u2f" }}" method="POST">
<div class="row">
<h1>Add U2F Security Key</h1>
<div class="row">
<div class="col s12 m6 l6">
<p>Please add your U2F (USB, NFC, or Bluetooth) Security Key, e.g. Yubikey.</p>
<p>If your MFA application supports scanning QR codes, scan the following image with its camera.</p>
<p>Next, enter two consecutive authentication codes in the boxes below and click "Add" below.</p>
<div class="input-field">
<input id="mfacode1" name="mfacode1" type="text" class="validate" pattern="[A-Za-z0-9]{4,8}"
title="Authentication code should contain maximum of 25 characters and consists of A-Z, a-z, and 0-9 characters."
required />
<label for="mfacode1">Authentication Code 1</label>
</div>
<div class="input-field">
<input id="mfacode2" name="mfacode2" type="text" class="validate" pattern="[A-Za-z0-9]{4,8}"
title="Authentication code should contain maximum of 25 characters and consists of A-Z, a-z, and 0-9 characters."
required />
<label for="mfacode2">Authentication Code 2</label>
</div>
</div>
</div>
</div>
<div class="row right">
<button type="submit" name="submit" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-plus-circle left app-btn-icon"></i>
<span class="app-btn-text">Add Token</span>
</button>
</div>
</form>
{{ end }}
{{ if eq .Data.view "password" }}
<form action="{{ pathjoin .ActionEndpoint "/settings/password/edit" }}" method="POST">
<div class="row">
<h1>Password Management</h1>
<div class="row">
<div class="col s12 m6 l6">
<p>If you want to change your password, please provide your current password and
</p>
<div class="input-field">
<input id="secret1" name="secret1" type="password" required />
<label for="secret1">Current Password</label>
</div>
<div class="input-field">
<input id="secret2" name="secret2" type="password" required />
<label for="secret2">New Password</label>
</div>
<div class="input-field">
<input id="secret3" name="secret3" type="password" required />
<label for="secret3">Confirm New Password</label>
</div>
</div>
</div>
</div>
<div class="row right">
<button type="submit" name="submit" class="btn waves-effect waves-light navbtn active navbtn-last app-btn">
<i class="las la-paper-plane left app-btn-icon"></i>
<span class="app-btn-text">Change Password</span>
</button>
</div>
</form>
{{ end }}
{{ if eq .Data.view "password-edit" }}
{{ if eq .Data.status "success" }}
<h1>Password Has Been Changed</h1>
<p>Please log out and log back in.</p>
{{ else }}
<h1>Password Change Failed</h1>
<p>Reason: {{ .Data.status_reason }} </p>
<a href="{{ pathjoin .ActionEndpoint "/settings/password" }}">
<button type="button" class="btn waves-effect waves-light navbtn active">
<i class="las la-undo-alt left app-btn-icon"></i>
<span class="app-btn-text">Try Again</span>
</button>
</a>
{{ end }}
{{ end }}
{{ if eq .Data.view "misc" }}
<p>The {{ .Data.view }} view is under construction.</p>
{{ end }}
</div>
</div>
</div>
<!-- Optional JavaScript -->
<script src="{{ pathjoin .ActionEndpoint "/assets/materialize-css/js/materialize.js" }}"></script>
<script src="{{ pathjoin .ActionEndpoint "/assets/highlight.js/js/highlight.js" }}"></script>
<script src="{{ pathjoin .ActionEndpoint "/assets/highlight.js/js/languages/json.min.js" }}"></script>
{{ if eq .Data.ui_options.custom_js_required "yes" }}
<script src="{{ pathjoin .ActionEndpoint "/assets/js/custom.js" }}"></script>
{{ end }}
<script>
hljs.initHighlightingOnLoad();
</script>
{{ if .Message }}
<script>
var toastHTML = '<span class="app-error-text">{{ .Message }}</span><button class="btn-flat toast-action" onclick="M.Toast.dismissAll();">Close</button>';
toastElement = M.toast({
html: toastHTML,
classes: 'toast-error'
});
const appContainer = document.querySelector('.app-container')
appContainer.prepend(toastElement.el)
</script>
{{ end }}
</body>
</html>`,
}
PageTemplates stores UI templates.
View Source
var Themes = map[string]interface{}{ "basic": true, }
Themes stores UI themes.
Functions ¶
This section is empty.
Types ¶
type StaticAsset ¶ added in v1.2.5
type StaticAsset struct {
Path string
Restricted bool
ContentType string
Content string
EncodedContent string
Checksum string
}
StaticAsset is a single static web asset.
type StaticAssetLibrary ¶ added in v1.2.5
type StaticAssetLibrary struct {
// contains filtered or unexported fields
}
StaticAssetLibrary contains a collection of static assets.
var StaticAssets *StaticAssetLibrary
StaticAssets is an instance of StaticAssetLibrary.
func NewStaticAssetLibrary ¶ added in v1.2.5
func NewStaticAssetLibrary() (*StaticAssetLibrary, error)
NewStaticAssetLibrary returns an instance of StaticAssetLibrary.
func (*StaticAssetLibrary) AddAsset ¶ added in v1.2.19
func (sal *StaticAssetLibrary) AddAsset(path, contentType, fsPath string) error
AddAsset adds asset to StaticAssetLibrary
func (*StaticAssetLibrary) GetAsset ¶ added in v1.2.5
func (sal *StaticAssetLibrary) GetAsset(path string) (*StaticAsset, error)
GetAsset returns an asset from path
type UserInterfaceArgs ¶
type UserInterfaceArgs struct {
Title string
LogoURL string
LogoDescription string
ActionEndpoint string
Message string
MessageType string
PublicLinks []UserInterfaceLink
PrivateLinks []UserInterfaceLink
Realms []UserRealm
Authenticated bool
Data map[string]interface{}
RegistrationEnabled bool
PasswordRecoveryEnabled bool
MfaEnabled bool
CustomCSSEnabled bool
CustomJsEnabled bool
}
UserInterfaceArgs is a collection of page attributes that needs to be passed to Render method.
type UserInterfaceFactory ¶
type UserInterfaceFactory struct {
//TemplatePrefix string `json:"template_prefix,omitempty"`
Templates map[string]*UserInterfaceTemplate `json:"templates,omitempty"`
Title string `json:"title,omitempty"`
LogoURL string `json:"logo_url,omitempty"`
LogoDescription string `json:"logo_description,omitempty"`
RegistrationEnabled bool `json:"registration_enabled,omitempty"`
PasswordRecoveryEnabled bool `json:"password_recovery_enabled,omitempty"`
MfaEnabled bool `json:"mfa_enabled,omitempty"`
// The links visible to anonymoous user
PublicLinks []UserInterfaceLink `json:"public_links,omitempty"`
// The links visible to authenticated user
PrivateLinks []UserInterfaceLink `json:"private_links,omitempty"`
// The authentication realms/domains
Realms []UserRealm `json:"realms,omitempty"`
// The pass to authentication endpoint. This is where
// user credentials will be passed to via POST.
ActionEndpoint string `json:"-"`
CustomCSSPath string `json:"custom_css_path,omitempty"`
CustomJsPath string `json:"custom_js_path,omitempty"`
}
UserInterfaceFactory represents a collection of HTML templates and associated methods for the creation of HTML user interfaces.
func NewUserInterfaceFactory ¶
func NewUserInterfaceFactory() *UserInterfaceFactory
NewUserInterfaceFactory return an instance of a user interface factory.
func (*UserInterfaceFactory) AddBuiltinTemplate ¶
func (f *UserInterfaceFactory) AddBuiltinTemplate(name string) error
AddBuiltinTemplate adds a built-in template to UserInterfaceFactory
func (*UserInterfaceFactory) AddBuiltinTemplates ¶
func (f *UserInterfaceFactory) AddBuiltinTemplates() error
AddBuiltinTemplates adds all built-in template to UserInterfaceFactory
func (*UserInterfaceFactory) AddTemplate ¶
func (f *UserInterfaceFactory) AddTemplate(s, tp string) error
AddTemplate adds a template to UserInterfaceFactory.
func (*UserInterfaceFactory) DeleteTemplates ¶
func (f *UserInterfaceFactory) DeleteTemplates()
DeleteTemplates removes all templates from UserInterfaceFactory.
func (*UserInterfaceFactory) GetArgs ¶
func (f *UserInterfaceFactory) GetArgs() *UserInterfaceArgs
GetArgs return an instance of UserInterfaceArgs. Upon the receipt of the arguments, they can be manipulated and passed to UserInterfaceFactory.Render method. The manipulation means adding an error message, appending to the title of a page, adding arbitrary data etc.
func (*UserInterfaceFactory) Render ¶
func (f *UserInterfaceFactory) Render(name string, args *UserInterfaceArgs) (*bytes.Buffer, error)
Render returns a pointer to a data buffer.
type UserInterfaceLink ¶
type UserInterfaceLink struct {
Link string `json:"link,omitempty"`
Title string `json:"title,omitempty"`
Style string `json:"style,omitempty"`
}
UserInterfaceLink represents a single HTML link.
type UserInterfaceParameters ¶ added in v1.2.6
type UserInterfaceParameters struct {
Theme string `json:"theme,omitempty"`
Templates map[string]string `json:"templates,omitempty"`
AllowRoleSelection bool `json:"allow_role_selection,omitempty"`
Title string `json:"title,omitempty"`
LogoURL string `json:"logo_url,omitempty"`
LogoDescription string `json:"logo_description,omitempty"`
PrivateLinks []UserInterfaceLink `json:"private_links,omitempty"`
AutoRedirectURL string `json:"auto_redirect_url"`
Realms []UserRealm `json:"realms"`
PasswordRecoveryEnabled bool `json:"password_recovery_enabled"`
CustomCSSPath string `json:"custom_css_path,omitempty"`
CustomJsPath string `json:"custom_js_path,omitempty"`
}
UserInterfaceParameters represent a common set of configuration settings for HTML UI.
type UserInterfaceTemplate ¶
type UserInterfaceTemplate struct {
Alias string `json:"alias,omitempty"`
// Path could be `inline`, URL path, or file path
Path string `json:"path,omitempty"`
Template *template.Template `json:"-"`
}
UserInterfaceTemplate represents a user interface instance, e.g. a single HTML page.
func NewUserInterfaceTemplate ¶
func NewUserInterfaceTemplate(s, tp string) (*UserInterfaceTemplate, error)
NewUserInterfaceTemplate returns a user interface template
Source Files
Click to show internal directories.
Click to hide internal directories.