mirror of
https://github.com/janishutz/libreevent.git
synced 2025-11-25 05:14:23 +00:00
update docs
This commit is contained in:
14
website/dist/docs/setup/index.html
vendored
14
website/dist/docs/setup/index.html
vendored
@@ -13,15 +13,17 @@
|
||||
</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>Getting Started</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Getting Started</h1>
|
||||
<p>In this tutorial, you are going to learn how to set up and configure libreevent.</p>
|
||||
<p>Installing libreevent will take you about 2 hour, if you have never made anything similar before. If you don't want to deal with the installation, you may contact us <a href="https://api.janishutz.com/contact/setup?origin=libreevent&campaign=installation-docs">here</a>, so we can set it up for you.</p>
|
||||
<p>Installing libreevent will take you about 2 hour, if you have never made anything similar before. If you don't want to deal with the installation, you may contact us <a href="https://support.janishutz.com/index.php?a=add&category=8">here</a>, so we can set it up for you.</p>
|
||||
<p>Let's begin the installation <a href="/docs/setup/installation">here</a>!</p>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
35
website/dist/docs/setup/installation/index.html
vendored
35
website/dist/docs/setup/installation/index.html
vendored
@@ -13,40 +13,38 @@
|
||||
</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>Installation</h1>
|
||||
<p>Let's begin with setting up libreevent! If you are not technically savvy or want somebody else to set it up for you, please contact me <a href="https://api.janishutz.com/contact/setup?origin=libreevent&campaign=installation-docs">here</a>. If you want to set it up yourself, read on below! Soon, there will also be a video tutorial available.</p>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Installation</h1>
|
||||
<p>Let's begin with setting up libreevent! If you are not technically savvy or want somebody else to set it up for you, please contact me <a href="https://support.janishutz.com/index.php?a=add&category=8">here</a>. If you want to set it up yourself, read on below!</p>
|
||||
<h1>Selecting a webhosting company</h1>
|
||||
<p>Choosing the right hosting provider is not easy, especially since libreevent requires node.js. Therefore, we've listed a few really good options. Whatever hosting provider you end up going with, it is important that they explicitly list Node.js as a feature of that hosting account. All hosting providers below also include MySQL which is beneficial to have and a must-have when you are expecting to sell a lot of tickets simultaneously. This website here is hosted by asurahosting. <em>Note: I may receive a small commission when you buy webhosting using one of the links provided below. This won't affect the price you pay.</em></p>
|
||||
<p>Choosing the right hosting provider is not easy, especially since libreevent requires node.js. Therefore, we've listed a few excellent options. Whatever hosting provider you end up going with, it is important that they explicitly list Node.js as a feature of that hosting account. All hosting providers below also include MySQL which is beneficial to have and a must-have when you are expecting to sell a lot of tickets simultaneously. This website here is hosted by asurahosting. <em>Note: I may receive a small commission when you buy webhosting using one of the links provided below. This won't affect the price you pay.</em></p>
|
||||
<ul>
|
||||
<li><a href="https://clients.asurahosting.com/aff.php?aff=1997">asurahosting</a></li>
|
||||
<li><a href="https://www.novatrend.ch/en/">novatrend</a></li>
|
||||
<li><a href="https://www.hetzner.com/">hetzner</a> (though make sure that you have a sufficiently high-end account!)</li>
|
||||
</ul>
|
||||
<p><em>Affiliate programs: TODO: Sign up</em>
|
||||
https://affiliates.hostinger.com/users/signup/
|
||||
https://www.a2hosting.com/about/affiliate-program/
|
||||
https://www.digitalocean.com/go/affiliates</p>
|
||||
<p></p>
|
||||
<h1>Downloading libreevent</h1>
|
||||
<p>We are going to start off by downloading libreevent. On this website, open the navigation menu and head to "Downloads". (We would strongly suggest that you open the link in a new tab by right clicking on the link and hitting "Open in new tab"). Below, hit the download button. This will download a production ready build of libreevent as a zip file. Save it to any convenient location. Head there and extract the zip-Archive (On windows, right click, extract; On MacOS, just double click; on Linux, there is either a zip utility installed or otherwise use the unzip utility in the terminal).</p>
|
||||
<p>We are going to start off by downloading libreevent. On this website, open the navigation menu and head to "Downloads". (We would strongly suggest that you open the link in a new tab by right-clicking on the link and hitting "Open in new tab"). Below, hit the download button. This will download a production ready build of libreevent as a zip file. Save it to any convenient location. Head there and extract the zip-Archive (On Windows, right click, extract; On MacOS, just double click; on Linux, there is either a zip utility installed or otherwise use the <code>unzip</code> utility in the terminal).</p>
|
||||
<h1>Defining a setup key</h1>
|
||||
<p>libreevent uses what we call a setup key. You need to set this manually, as it needs to be different for every install because otherwise the whole point of this setup key is to prevent unauthorized access to the setup program. The setup will be disabled once you have first completed it.</p>
|
||||
<p>To set the setup key, navigate to the extracted libreevent folder and open it. In there you should find a file called "setupkey.txt". Open it up and add any random assortment of characters and numbers in there. What we recommend is that you just roll your hand over your keyboard in any way you like as this generates a very much unpredictable assortment of characters. Then, hit Ctrl + S (or Command + S on MacOS) to save the file. We would recommend leaving this file open, as you will need the setup key at a later point.</p>
|
||||
<h1>Uploading libreevent</h1>
|
||||
<p>It is now time to upload libreevent to your webhosting account. The recommended way of doing this is to download an FTP client like "FileZilla" and to connect to the hosting account in that way using the credentials provided by the hosting provider. In this guide we assume you use this way.</p>
|
||||
<p>Download and install FileZilla <a href="https://filezilla-project.org/download.php?platform=win64">for Windows (64-bit)</a>, <a href="https://filezilla-project.org/download.php?platform=osx">for MacOS</a> or for Linux (available in all major distro repos). It is a free and open source FTP client. Open it and you will see a few empty fields towards the top of the app. There you will need to fill in the information given by your hosting provider. Usually, the Host is ftp.yourDomain.com, the username and password are usually your admin account credentials and the port is usually 25552 or can be left empty. Then hit quick connect. At this point, a SSL warning might appear, as the certificate might not (yet) be configured correctly to also include FTP. Accept the certificate and you should be connected.</p>
|
||||
<p>Now create a new folder called "libreevent" by right clicking onto the empty space on the right pane (where it says "remote site") and selecting "create directory". Then on the left side (where it says "local side" navigate to the extracted libreevent folder and upload its contents by selecting it and right clicking to hitting "Upload"). Once that process is completed, you should be set to go to the next session.</p>
|
||||
<p><strong>IMPORTANT:</strong> Never upload libreevent into any public_html folders ever! This poses a SEVERE security risk and, if a JSON database is used, exposes ALL userdata to the internet! Always upload to a non-publicly accessible folder!</p>
|
||||
<p>Download and install FileZilla <a href="https://filezilla-project.org/download.php?platform=win64">for Windows (64-bit)</a>, <a href="https://filezilla-project.org/download.php?platform=osx">for MacOS</a> or for Linux (available in all major distro repos). It is a free and open source FTP client. Open it, and you will see a few empty fields towards the top of the app. There you will need to fill in the information given by your hosting provider. Usually, the Host is ftp.yourDomain.com, the username and password are usually your admin account credentials and the port is usually 25552 or can be left empty. Then hit quick connect. At this point, an SSL warning might appear, as the certificate might not (yet) be configured correctly to also include FTP. Accept the certificate and you should be connected.</p>
|
||||
<p>Now create a new folder called "libreevent" by right-clicking onto the empty space on the right pane (where it says "remote site") and selecting "create directory". Then on the left side (where it says "local side" navigate to the extracted libreevent folder and upload its contents by selecting it and right-clicking to hitting "Upload"). Once that process is completed, you should be set to go to the next session.</p>
|
||||
<p><strong>IMPORTANT:</strong> Never upload libreevent into any public_html folders ever! This poses a SEVERE security risk and, if a JSON database is used, exposes ALL user data to the internet! Always upload to a non-publicly accessible folder!</p>
|
||||
<h2>npm install</h2>
|
||||
<p>This project relies on a variety of different node.js modules that need to be installed on the server. Most webhosting providers give you an easy way to run <em>npm install</em>. If not, you might be required to upload the <em>node_modules</em> folder yourself. You can create such a folder either by downloading the <em>node_modules.zip</em> folder from the Download page or by installing npm on your local machine and then by running <em>npm i</em> in the terminal.</p>
|
||||
<p>To set up the node application in most hosting providers, head to the admin panel of your hosting account once again. Navigate to the main page and scroll down until you find something that says "Setup Node.js App". Click it and wait for it to load. Click "Create Application" and select the newest available Node.js version and set the Application mode to "Production". For the application root insert the directory name which you have created just before when uploading.</p>
|
||||
<p>For the Application URL field, click onto "Choose any value" and select an appropriate domain.</p>
|
||||
<p>For the Application startup file type "app.js".</p>
|
||||
<p>In the section "Environment variables" hit "Add Variable" and in the appearing fields type beneath "Name" the following: "PORT" (without the quotes!) and under "Value" "8080" (again without quotes). Then hit done and at the top "create". If you end up on the start page again, hit the little pencil icon to get to the application editor. Scroll down to the "Detected configuration files" section and click "Run NPM Install". Once it shows a success message (at the top!), hit "Restart".</p>
|
||||
<p>CONGRATULATIONS! You are all set with the installation of libreevent! Now open a new tab in your webbrowser and type your domain name. If you can connect to your domain and libreevent is accessible, you are all set!</p>
|
||||
<p>CONGRATULATIONS! You are all set with the installation of libreevent! Now open a new tab in your web browser and type your domain name. If you can connect to your domain and libreevent is accessible, you are all set!</p>
|
||||
<p>You may now continue reading the <a href="/docs/setup/setup">Setup guide</a></p>
|
||||
<h1>Troubleshooting</h1>
|
||||
<p>Here are some tips for the most common problems that might arise from the installation</p>
|
||||
@@ -61,7 +59,7 @@ https://www.digitalocean.com/go/affiliates</p>
|
||||
<h3>ERR_ENCODING_NOT_SUPPORTED</h3>
|
||||
<p>If this error occurs, most likely, the Node.js build of your hosting provider is set to small-icu mode, meaning some localizations are missing, one of which is ascii, which is required by the pdf generator that libreevent uses. To resolve this, you will need to download a special package.json file and add two (more) environment variables:</p>
|
||||
<ul>
|
||||
<li>For the package.json file, download it from <a href="https://api.janishutz.com/download/libreevent?v=latest&type=icu">here</a> </li>
|
||||
<li>For the package.json file, download it from <a href="https://api.janishutz.com/download/libreevent?v=latest&type=icu">here</a></li>
|
||||
<li>For the environment variables, add the following:</li>
|
||||
</ul>
|
||||
<pre><code>NODE_ICU_DATA=./node_modules/full-icu
|
||||
@@ -69,8 +67,9 @@ FULL_ICU_PREFER_NPM=true
|
||||
</code></pre>
|
||||
<p><img src="/assets/environmentVariables.png" alt="EnvVars"></p>
|
||||
<h3>Any other error</h3>
|
||||
<p>Please click <a href="https://github.com/simplePCBuilding/libreevent/issues/new">here</a> to head to GitHub and open a new issue. You will need to have a GitHub Account to open an issue. If you don't have a GitHub account, you may also contact me using my <a href="https://api.janishutz.com/contact/report?origin=libreevent?error=unkown?lang=en">Bug reporting tool</a>.</p>
|
||||
<p>Please click <a href="https://github.com/simplePCBuilding/libreevent/issues/new">here</a> to head to GitHub and open a new issue. You will need to have a GitHub Account to open an issue. If you don't have a GitHub account, you may also contact me using my <a href="https://support.janishutz.com/index.php?a=add&category=9">Bug reporting tool</a>.</p>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
12
website/dist/docs/setup/post-setup/index.html
vendored
12
website/dist/docs/setup/post-setup/index.html
vendored
@@ -13,13 +13,15 @@
|
||||
</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>Post-Setup</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Post-Setup</h1>
|
||||
<p>As soon as you have completed setting up libreevent, there are some things you want to change on the admin panel. First off, you want to create an <a href="/docs/admin-panel/locations">event location</a> and an <a href="/docs/admin-panel/events">event</a>. Secondly, you may want to customize the start page, which you can do in the pages settings on the admin panel. You may find documentation for this <a href="/docs/admin-panel/pages">here</a>. Lastly, you need to configure and set up a <a href="/docs/admin-panel/settings#payment-gateway">payment gateway</a> in order for you to accept payments. Additionally, have a look around on the admin panel to change settings where you see fit.</p>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
14
website/dist/docs/setup/security/index.html
vendored
14
website/dist/docs/setup/security/index.html
vendored
@@ -13,17 +13,19 @@
|
||||
</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>Security best practices</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Security best practices</h1>
|
||||
<p>Whilst libreevent uses modern security features, no Software is perfect when it comes to security. This is why it is important to keep libreevent updated, as potential security issues are addressed with them, as well as potential bugs. Next to that, an incorrectly set up instance of libreevent might pose a security problem, but we try to make the attack surface as small as possible. The most significant security risk that can arise from improperly setting up libreevent is not using HTTPS for the server.</p>
|
||||
<h2>Reverse Proxy</h2>
|
||||
<p>For simplicity reasons, libreevent does not (yet) natively support SSL-Certificates. This is why libreevent should be put behind a reverse proxy to ensure that all users use SSL (Secure Sockets Layer) or TLS (Transport Layer Security) when connecting to it. Most webhosting plans are already behind a reverse proxy, you will just need to force a HTTPS redirect in the settings of the admin panel of the webhosting account. If you are manually deploying libreevent on a server without a reverse proxy, we urge you to use a reverse proxy with e.g. nginx or apache. There are a lot of guides out there on how to set a such up. Please also get yourself a Certificate for your domain and activate it. A common methods for acquiring such Certificates is to use the "Certbot" CLI application on Linux. It works with both apache and nginx and can automatically renew the certificate for you once it expires if set to run on a cronjob (highly recommended).</p>
|
||||
<p>For simplicity reasons, libreevent does not (yet) natively support SSL-Certificates. This is why libreevent should be put behind a reverse proxy to ensure that all users use SSL (Secure Sockets Layer) or TLS (Transport Layer Security) when connecting to it. Most webhosting plans are already behind a reverse proxy, you will just need to force a HTTPS redirect in the settings of the admin panel of the webhosting account. If you are manually deploying libreevent on a server without a reverse proxy, we urge you to use a reverse proxy with e.g. nginx or apache. There are a lot of guides out there on how to set a such up. Please also get yourself a Certificate for your domain and activate it. A common method for acquiring such Certificates is to use the "Certbot" CLI application on Linux. It works with both Apache and nginx and can automatically renew the certificate for you once it expires if set to run on a cronjob (highly recommended).</p>
|
||||
<h2>HTTPS</h2>
|
||||
<p>As mentioned previously in the Reverse Proxy section, you should always have HTTPS enabled using a reverse proxy. Since most hosting accounts already have a reverse proxy installed, you just need to set it to automatically redirect HTTP to HTTPS in the webhosting admin panel.</p>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
34
website/dist/docs/setup/setup/index.html
vendored
34
website/dist/docs/setup/setup/index.html
vendored
@@ -13,12 +13,13 @@
|
||||
</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>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/installation">here</a>. Let's get started setting up your event management system!</p>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Setup of libreevent</h1>
|
||||
<p>At this point we assume you've completed the initial installation 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 "Start setup". You will now land on the setup start page. You may hit "Start setup" 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,14 +27,14 @@
|
||||
<p>This page prepares libreevent for use, covering all the basics, the name of the website, database and email accounts.
|
||||
The first setting you may change here is the name of the website. Choose wisely, as changing the name at a later point is hard, not explained in the documentation and also doesn't make for a good image.</p>
|
||||
<h3>Database</h3>
|
||||
<p>In the database, all the userdata is stored. libreevent currently supports two different databases, MySQL and a custom database based on JSON. Which one to choose?</p>
|
||||
<p>In the database, all the user data is stored. libreevent currently supports two different databases, MySQL and a custom database based on JSON. Which one to choose?</p>
|
||||
<p>Generally MySQL, except:</p>
|
||||
<ul>
|
||||
<li>If your organisation is small and does only sell a few tickets at a time, the JSON based database can be an easy to set up alternative.</li>
|
||||
<li>Your web hosting plan does not includes MySQL and you've got no access to MySQL in any other way. <em>NOTE: Free MySQL services should NEVER be used in such an application, as most hosting plans include MySQL (or MariaDB, which works similarly) which is much more reliable and if you lose access to the database, you can only access the root account and all other user data (and therefore all user accounts) is lost. The event data is always stored in JSON format as it is more efficient this way.</em></li>
|
||||
<li>If your organization is small and does only sell a few tickets at a time, the JSON based database can be an easy to set up alternative.</li>
|
||||
<li>Your web hosting plan does not include MySQL, and you've got no access to MySQL in any other way. <em>NOTE: Free MySQL services should NEVER be used in such an application, as most hosting plans include MySQL (or MariaDB, which works similarly) which is much more reliable and if you lose access to the database, you can only access the root account and all other user data (and therefore all user accounts) is lost. The event data is always stored in JSON format as it is more efficient this way.</em></li>
|
||||
</ul>
|
||||
<p><strong>NOTE: The JSON database is really slow and should only be used if you have a small event where you expect to sell less than 5 ticket per minute at any time! The amount of tickets sold per minute that the system can handle really depends on the speed of the server the website runs on.</strong></p>
|
||||
<p>MySQL generally is more time consuming to set up (taking about ten minutes compared to zero), but we'll run you through the process here to make the process easier for you.</p>
|
||||
<p><strong>NOTE: The JSON database is really slow and should only be used if you have a small event where you expect to sell less than 10 tickets per minute at any time! The amount of tickets sold per minute that the system can handle really depends on the speed of the server the website runs on.</strong></p>
|
||||
<p>MySQL generally is more time-consuming to set up (taking about ten minutes compared to zero), but we'll run you through the process here to make the process easier for you.</p>
|
||||
<p>If you are really sure that you want to use the JSON-based database, skip the next section.</p>
|
||||
<h3>Setting up a MySQL database</h3>
|
||||
<p>At this point, we assume that you are logged in to the administration panel of your webhosting provider. This guide will use the Web Control Panel called "Direct Admin", as it is fairly common, along with cPanel. Somewhere, there should be a button that says something like "MySQL Management". Click it, which will bring you to the MySQL-Database management page. Now, create a new database by clicking the "Create new database" (or similar) button which will bring up the database creation tool. Give the database any name you like (libreevent would though be a reasonable choice) and give the user any name you like. When creating a password, it is important that this password is long and complicated. What we recommend doing is using a password generator or to essentially "sit" onto your keyboard to get a random string of characters as the password.</p>
|
||||
@@ -45,10 +46,10 @@ The first setting you may change here is the name of the website. Choose wisely,
|
||||
<p>In the "display" section, you can customize how the email address shows up for customers. What we are doing here is known as email address spoofing, if you change what email address is shown. This is being shunned actively by some email providers, which means, the value entered in the "Email address to show" field should be the same as the actual email address. For the display name, you can get creative.</p>
|
||||
<p>With the main part of setup complete, hit continue, to advance to root account setup.</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>This is the most powerful account in this system. From it, you can control EVERY aspect of your system.</p>
|
||||
<p></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>
|
||||
<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 fulfils 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>
|
||||
@@ -75,15 +76,16 @@ The first setting you may change here is the name of the website. Choose wisely,
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Please avoid using easy to guess combinations like names & birth dates of you or your relatives, zip codes & cities and obvious words like 'password', 'libreevent', 'admin', 'root' and your organisation / event's name.</p>
|
||||
<p>Please avoid using easy to guess combinations like names & birthdates of you or your relatives, postcodes & cities and obvious words like 'password', 'libreevent', 'admin', 'root' and your organization / 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>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.</p>
|
||||
<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.</p>
|
||||
<p>libreevent already gives you the link to the admin panel, which you can click, but if you already closed the page, here's how to reach it:</p>
|
||||
<p><em>You can find your admin panel at /admin (example: libreevent.janishutz.com/admin, replace libreevent.janishutz.com with your own domain).</em></p>
|
||||
<p><strong>Congratulations! You've now successfully set up your event management solution.</strong></p>
|
||||
<p><em>You may find documentation on the admin panel <a href="/docs/admin-panel/">here</a></em></p>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
15
website/dist/docs/setup/update/index.html
vendored
15
website/dist/docs/setup/update/index.html
vendored
@@ -13,15 +13,18 @@
|
||||
</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>Updating</h1>
|
||||
<div class="doc-main">
|
||||
<div id="side-bar"></div>
|
||||
<div id="backToTop" onclick="backToTop();"></div>
|
||||
<div id="docPage">
|
||||
<div id="doc-container">
|
||||
<h1>Updating</h1>
|
||||
<p>Updating libreǝvent is important to keep it secure, performant and bug-free. Currently, updating libreevent involves manually uploading the new files.</p>
|
||||
<p><strong>IMPORTANT: make sure to ALWAYS download the data and config directories before updating to not lose any data in case something goes wrong! When uploading, do NOT upload the data and config directories except the release note tell you anything else. Please also always follow any notes detailed in the release notes.</strong></p>
|
||||
<p>There are currently no updates available, this section will be expanded, once there is.</p>
|
||||
<p>To update, download the latest version of libreevent from the <a href="/download">download</a> page. Then, open up FileZilla or any other FTP client, connect to your webhosting account and navigate to the libreevent directory. Then, unzip the downloaded libreevent package. In FileZilla, navigate to the extracted archive on the local side. Select all folders, bar config and data upload them.</p>
|
||||
<p>Then, restart libreevent.</p>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
Reference in New Issue
Block a user