Files
libreevent/website/dist/docs/setup/setup/index.html

73 lines
5.5 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<title>Setup of libreevent :: 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>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>
<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 it into the field and hit &quot;Start setup&quot;.</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>
<h2>Root account</h2>
<p>This is the most powerful account in this system. From it you can control EVERY aspect of your system.</p>
<p><strong>Remark: You may (and definitely should) add other accounts with less privileges after completing setup and only use the root account when it is actually necessary</strong></p>
<p>Please choose an email address to which you want to link the root account. Two-Factor-Authentication is ALWAYS required when logging into an account that has root privileges to ensure a higher degree of security, so please ensure you have access to that email address at all times.</p>
<p>When choosing a password, please ensure it meets the minimum requirements of the system or let the system generate one for you by clicking the 'generate password' button, which will generate a password that fulfills all requirements and exceeds the minimum requirements for password length. In the table below, you may see all the password requirements:</p>
<table>
<thead>
<tr>
<th>Factor</th>
<th>Requirement</th>
</tr>
</thead>
<tbody>
<tr>
<td>Length</td>
<td>At least 15 characters</td>
</tr>
<tr>
<td>Special characters</td>
<td>At least 2 required</td>
</tr>
<tr>
<td>Numbers</td>
<td>At least 2 required</td>
</tr>
<tr>
<td>Upper / Lower case</td>
<td>At least 2 upper &amp; 2 lower case letters required</td>
</tr>
</tbody>
</table>
<p>Please avoid using easy to guess combinations like names &amp; birth dates of you or your relatives, zip codes &amp; cities and obvious words like 'password', 'libreevent', 'admin', 'root' and your organisation / event's name.</p>
<p>After this, the system will email you an email confirmation link using the email you've previously configured in the config.json file during installation.</p>
<h2>Page setup</h2>
<p>After having set up the root account and confirmed the email address, it is now time to set the name of the webpage. For this, you'll need to enter your organisation's name and choose the offered languages. Note that for every language you select, you need to add a promotional text. Please select a homepage template from <a href="/docs/homepage/templates">here</a>. You also have to upload an/some image(s) at this stage, if the selected template requires (an) image(s).</p>
<h2>Payment methods</h2>
<p>Now it is time to set up some payment methods. You may find advantages / disadvantages of each payment gateway <a href="/docs/payments">here</a>. It is advised to only choose one payment gateway which provides lots of different payment options, but cost of usage can also be a factor to consider. You may add more payment options by downloading a plugin through the plugin installer in the admin panel. <em>Note: You'll have to restart the node app whenever you install a new plugin!</em></p>
<h2>Event setup</h2>
<p>With payment methods sorted, you now have to add an event. For this, you'll need to create tickets by hitting the plus icon.</p>
<h2>TOS</h2>
<p>This is an optional step. Here you may add your own terms of services (TOS), next to the ones that are given by libreevent itself. Your TOS will be inserted at the top.</p>
<h2>Setup complete</h2>
<p>With this, you've completed the setup of the event. We now ask you to restart the node application. You may do this by stopping the process (if logged in via SSH, press Ctrl + C, if you've got a graphical user interface for setting up the node app, it should be self explanatory) and restarting it as described <a href="/docs/setup/installation#starting">here</a>.</p>
<p><strong>Congratulations! You've now successfully set up your event management solution. You may now log into the admin panel. You can find your admin panel at /admin (example: libreevent.janishutz.com/admin, replace libreevent.janishutz.com with your own domain).</strong></p>
<p><em>You may find documentation on the admin panel <a href="/docs/admin-panel/">here</a></em></p>
</div>
</div>
<div id="footer"></div>
</body>
</html>