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

lots of progress on docs

Browse Source
This commit is contained in:
Janis Hutz
2023-09-30 16:56:42 +02:00
parent 5a3323a0ea
commit ee7b90cd93
21 changed files with 113 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
website/dist/docs/admin-panel/admin-accounts/index.html vendored
View File

@@ -1,62 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Admin Accounts :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.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">
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></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>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
</body>
</html>

8
website/dist/docs/admin-panel/index.html vendored
View File

@@ -19,8 +19,8 @@
<div id="doc-container">
<h1>Home</h1>
<p>The admin panel is where you can change basically everything about libreevent.
&lt;!-- In a future update, depending on your account's privileges, you may find more or less settings. Only the root account has access to the admin accounts page. Currently though, all pages are unlocked for all users. --&gt;</p>
<p>Here's a list of the pages available when logged in as the root user. &lt;!-- All other users have fewer pages enabled.--&gt;</p>
</p>
<p>Here's a list of the pages available when logged in as the root user. </p>
<ul>
<li><a href="/docs/admin-panel/events">Events</a></li>
<li><a href="/docs/admin-panel/locations">Locations</a></li>
@@ -29,8 +29,8 @@
<li><a href="/docs/admin-panel/seatplan-editor">Seatplan editor</a></li>
<li><a href="/docs/admin-panel/settings">Settings</a></li>
</ul>
<p>&lt;!-- Additionally, some settings might not be available to all admin accounts on all pages. --&gt;</p>
<p>&lt;!-- <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>. --&gt;</p>
<p></p>
<p></p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>

29
website/dist/docs/admin-panel/settings/index.html vendored
View File

@@ -53,34 +53,9 @@ The following settings are available:</p>
<h3>Gateway settings</h3>
<p>Here you need to enter gateway specific settings to make them work. Do note, that some gateway plugins might crash libreevent on startup if these settings aren't entered, if you are using an unofficial plugin. All officially supported plugins will not crash it if the values entered are incorrect</p>
<h1>Admin Accounts</h1>
<p>On this page you may add, modify or remove admin accounts. &lt;!--Note that in order for you to see this page, you'll need to be logged in as the user root.--&gt;</p>
<p>On this page you may add, modify or remove admin accounts. </p>
<h2>Adding an account</h2>
<p>&lt;!-- ### Privileges
TODO: will be added in future version
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 --&gt;</td>
<p></td>
</tr>
</tbody>
</table>

3
website/dist/docs/css/style.css vendored
View File

@@ -34,9 +34,6 @@ body {
}
.title-wrapper {
/*
TODO: Replace with image
*/
background-color: white;
display: flex;
text-align: center;

28
website/dist/docs/plugins/list-of-plugins/index.html vendored
View File

@@ -1,28 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>List of plugins :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.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">
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>List of plugins</h1>
<p>This list of plugins contains all official plugins of libreevent. For a more up-to-date version of this list, please check your</p>
<h2></h2>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
</body>
</html>

2
website/dist/docs/setup/setup/index.html vendored
View File

@@ -18,7 +18,7 @@
<div id="docPage">
<div id="doc-container">
<h1>Setup of libreevent</h1>
<p>At this point we assume you've completed the initial install of libreevent. If not, you may find a guide on how to do it <a href="/docs/setup/getting-started">here</a>. Let's get started setting up your event management system!</p>
<p>At this point we assume you've completed the initial install of libreevent. If not, you may find a guide on how to do it <a href="/docs/setup/installation">here</a>. Let's get started setting up your event management system!</p>
<h2>Connecting to the server</h2>
<p>As discussed in the previous part where we installed the system, you can connect to your server simply by opening a web browser and typing your domain name into the address field. After that you should be greeted by the libreevent post-install landing page. Once there, you'll need the setup key you defined during the installation. Type (or copy) it into the field and hit &quot;Start setup&quot;. You will now land on the setup start page. You may hit &quot;Start setup&quot; below to start the setup.</p>
<p><em>Note: This is only available during the setup process of libreevent and will afterwards be deactivated to ensure safety of the system.</em></p>

26
website/dist/docs/sponsor/index.html vendored
View File

@@ -1,26 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Sponsor :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.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">
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Sponsor</h1>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
</body>
</html>

2
website/dist/docs/sponsoring/index.html vendored
View File

@@ -19,7 +19,7 @@
<div id="doc-container">
<h1>Sponsoring</h1>
<p>As any project, libreevent also needs funding to keep development going. If you have used and liked libreevent and want to see it grow and become more feature rich, you might want to consider donating to the project. If you are a company and you want to become a sponsor of the project, please <a href="mailto:development@janishutz.com">contact me</a> for a sponsor deal.</p>
<p>&lt;!-- If you are an individual looking to support the development of libreevent, you may donate [here] TODO: Finish --&gt;</p>
<p></p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>

26
website/dist/docs/tutorial/index.html vendored
View File

@@ -1,26 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Tutorial :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.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">
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Tutorial</h1>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
</body>
</html>