janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 13:24:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

add some compiled html files

Browse Source
This commit is contained in:
Janis Hutz
2023-06-17 14:12:31 +02:00
parent 00a7aaa08f
commit 1b794e0742
27 changed files with 691 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
website/dist/docs/admin-panel/admin-accounts/index.html vendored Normal file
View File

@@ -0,0 +1,60 @@
<!DOCTYPE html>
<html>
<head>
<title>Admin Accounts :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Admin Accounts</h1>
<p>On this page you may add, modify or remove admin accounts. Note that in order for you to see this page, you'll need to be logged in as the user root.</p>
<h2>Adding an account</h2>
<h3>Privileges</h3>
<p>libreevent features a privilege system where you can choose to what group of users you want to add a user you are currently creating. Possible values are:</p>
<table>
<thead>
<tr>
<th>Group</th>
<th>Allowed settings</th>
</tr>
</thead>
<tbody>
<tr>
<td>Root</td>
<td>All pages. Can only be one account (the root account)</td>
</tr>
<tr>
<td>Admin</td>
<td>Can access all pages and settings except for Admin Accounts</td>
</tr>
<tr>
<td>Event-Manager</td>
<td>Access the events &amp; pages page</td>
</tr>
<tr>
<td>Event-Handler</td>
<td>Can log into the apps to do entry control</td>
</tr>
</tbody>
</table>
<h3>Email</h3>
<p>An Email address is required for account activation and to recover a password in case it gets lost. The system will automatically send an activation email so the user can confirm that the email address is valid.</p>
<h3>2FA</h3>
<p>With this checkbox you can choose if this user needs to do two factor authentication, meaning, if the user needs to authorise the login using a link. In the <a href="/docs/admin-panel/settings#2fa">Settings</a> you may choose between the two different 2FA modes that libreevent offers.</p>
<h2>Modifying an account</h2>
<h2>Removing an account</h2>
</div>
</div>
<div id="footer"></div>
</body>
</html>

33
website/dist/docs/admin-panel/events/index.html vendored Normal file
View File

@@ -0,0 +1,33 @@
<!DOCTYPE html>
<html>
<head>
<title>Events :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Events</h1>
<p>This is the most feature rich admin page of libreevent. Here you can change everything regarding an event.</p>
<h2>Creating new events</h2>
<p>Creating new events is as simple as clicking the plus icon in the top right corner and following the prompts.</p>
<h3>Event name</h3>
<p>This is the name that is being displayed when users are browsing your events. Cannot be longer than 50 characters.</p>
<h3>Event description</h3>
<p>Describe what your event is about. It will be displayed underneath the event name when users are browsing your events. In the browsing view, the length of the description is limited to 150 characters, after which three dots will be added to the text and a 'continue reading' button will be added. Technically, there's no limit to the length of the event description, but don't overdo it with the length, as the user is unlikely to read more than a couple words anyway.</p>
<h3>Event location</h3>
<p>Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide <a href="/docs/admin-panel/seatplan-editor">here</a></p>
</div>
</div>
<div id="footer"></div>
</body>
</html>

35
website/dist/docs/admin-panel/index.html vendored Normal file
View File

@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html>
<head>
<title>Admin panel :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Admin panel</h1>
<p>The admin panel is where you can change basically everything about libreevent. Depending on your account's privileges, you may find more or less settings. Only the root account has access to the admin accounts page.</p>
<p>Here's a list of the pages available when logged in as the root user. All other users have fewer pages enabled.</p>
<ul>
<li><a href="/docs/admin-panel/admin-accounts">Admin Accounts</a></li>
<li><a href="/docs/admin-panel/pages">Pages</a></li>
<li><a href="/docs/admin-panel/events">Events</a></li>
<li><a href="/docs/admin-panel/plugins">Plugins</a></li>
<li><a href="/docs/admin-panel/settings">Settings</a></li>
</ul>
<p>Additionally, some settings might not be available to all admin accounts on all pages.</p>
<p><em>As a general recommendation, we do not encourage logging in as the root user if not strictly necessary, as this can help protect the libreevent installation</em>.</p>
</div>
</div>
<div id="footer"></div>
</body>
</html>

24
website/dist/docs/admin-panel/pages/index.html vendored Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<title>Pages :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Pages</h1>
</div>
</div>
<div id="footer"></div>
</body>
</html>

24
website/dist/docs/admin-panel/plugins/index.html vendored Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<title>Plugins :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Plugins</h1>
</div>
</div>
<div id="footer"></div>
</body>
</html>

33
website/dist/docs/admin-panel/seatplan-editor/index.html vendored Normal file
View File

@@ -0,0 +1,33 @@
<!DOCTYPE html>
<html>
<head>
<title>Seatplan editor :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Seatplan editor</h1>
<p>The seatplan editor is a graphical editor where you can create and modify the seating plan of virtually any room. We recommend that you start in the top left corner of the seatplan and then move down diagonally, as it is the easiest to do. Each so-called component can be either a stand area, a stage area or a seating area, with each of them featuring different layouts. You can change everything in the properties pane.</p>
<h2>Adding more components</h2>
<p>You may add more components by simply clicking the plus icon in the toolbar of the editor. The component will spawn in the top left corner of the seatplan and the view will automatically be moved towards it.</p>
<h2>Removing components</h2>
<p>You may remove components by clicking the trash icon or by hitting 'delete' on your keyboard.</p>
<h2>Editing history</h2>
<p>The editor features undo and redo functions such that you can undo your mistakes and accidental undos can be reverted. Just hit the corresponding button in the toolbar.</p>
<h2>Saving</h2>
<p>The editor does auto-save a draft every minute. Pressing Ctrl + S or hitting the Save button in the toolbar will immediately save the seatplan as a draft. Click the deploy button to save the seatplan permanently, irreversibly overwriting any potentially existing old seatplan of that location, except you change the location name after the fact.</p>
</div>
</div>
<div id="footer"></div>
</body>
</html>

42
website/dist/docs/admin-panel/settings/index.html vendored Normal file
View File

@@ -0,0 +1,42 @@
<!DOCTYPE html>
<html>
<head>
<title>Settings :: docs - libreevent</title>
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/home.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
<link rel="stylesheet" href="/docs/css/style.css">
</head>
<body>
<div id="side-bar"></div>
<div id="nav"></div>
<div id="docPage">
<div id="doc-container">
<h1>Settings</h1>
<h2>2FA</h2>
<p>libreevent offers two different 2fa modes:</p>
<ul>
<li>Standard mode: The user has to click on a link that was sent to him via email. He'll automatically be logged in as soon as the page loads.</li>
<li>Enhanced mode: The user has to click on a link that was sent to him via email and then has to confirm it by entering the code that is shown to him on the 2FA page. After that he'll automatically be logged in.</li>
</ul>
<p>In both modes, the system informs the user about the IP address that tried to log into the account.</p>
<p>This setting can be changed individually for admin and user accounts and 2FA can be disabled entirely. It is highly encouraged to enable this at least for the admin accounts and for user accounts set the requirement to 'User-defined' or 'Always required' instead of 'Disabled'.</p>
<h2>User account passwords</h2>
<p>Here you may set password requirements for the user accounts. The system will always be offering the users to generate a password that is strong for them to facilitate the process of setting a password.</p>
<h2>Guest purchase</h2>
<p>Choose if a user may purchase a ticket without creating an account. An email address is always required as the system sends the tickets via email to the customers for easier access.</p>
<h2>Allow overbooking</h2>
<p>Activate this and set a percentage of overbooking, if you want to enable overbooking of the event to ensure that every single spot is occupied even if somebody does not show up. Use is strongly discouraged and currently only works with events that have no seating plan.</p>
<h2>Special requirements</h2>
<p>Here you may set a special requirement that a person booking a ticket has to fulfill, like the email address has to be ending in @yourdomain.com or they need to live in a certain street / town / city / country in order for them to be allowed to buy a ticket. You may also require that they provide a certain number, code or similar. Finally, you may choose to limit the amount of tickets a single person may reserve.</p>
<h2>Change organisation name</h2>
<p>This should be self explanatory, but keep in mind that this change will only take effect after the next restart of the node app.</p>
</div>
</div>
<div id="footer"></div>
</body>
</html>