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

progress on docs, fixes in basic setup

Browse Source
This commit is contained in:
Janis Hutz
2023-09-18 15:14:09 +02:00
parent 9a4d38be31
commit 130831f050
15 changed files with 143 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
website/src/setup/setup.md
View File

@@ -2,10 +2,44 @@
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 [here](&/setup/getting-started). Let's get started setting up your event management system!
## Connecting to the server
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 "Start setup".
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.
*Note: This is only available during the setup process of libreevent and will afterwards be deactivated to ensure safety of the system.*
## Basic Setup
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.
### Database
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?
Generally MySQL, except:
- 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.
- Your web hosting plan does not includes MySQL and you've got no access to MySQL in any other way. *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.*
**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.**
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.
If you are really sure that you want to use the JSON-based database, skip the next section.
### Setting up a MySQL database
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.
Now copy this password and head back to the libreevent setup page. In the "Database host name" field, change the domain, if libreevent hasn't recognized the correct one automatically (do not enter the protocol (like http:// or https://) in the host name field!). Under "database name", enter the name you just entered before when creating the database (including any prefixes shown there) and for the "database user" field, type the username you just created (again, including any prefixes shown in the admin panel). Now paste the password you just copied before into the "Password" field. The port should usually be fine.
Now head back to the admin panel of the webhosting provider. Hit "Create Database" to actually create the database.
And just like that, you have finished setting up your database.
### Email
libreevent needs to have access to an email address to be able to send emails to customers. In the "Account" section, you need to enter the mail connection details. You only need the data for the outgoing mail server, namely for a SMTP server, as this is what libreevent uses.
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.
With the main part of setup complete, hit continue, to advance to root account setup.
## Root account
This is the most powerful account in this system. From it you can control EVERY aspect of your system.
@@ -26,23 +60,13 @@ Please avoid using easy to guess combinations like names & birth dates of you or
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.
## Page setup
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 [here](&/homepage/templates). You also have to upload an/some image(s) at this stage, if the selected template requires (an) image(s).
## Payment methods
Now it is time to set up some payment methods. You may find advantages / disadvantages of each payment gateway [here](&/payments). 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. *Note: You'll have to restart the node app whenever you install a new plugin!*
## Event setup
With payment methods sorted, you now have to add an event. For this, you'll need to create tickets by hitting the plus icon.
## TOS
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.
## Setup complete
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 [here](&/setup/installation#starting).
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.
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:
**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).**
*You can find your admin panel at /admin (example: libreevent.janishutz.com/admin, replace libreevent.janishutz.com with your own domain).*
**Congratulations! You've now successfully set up your event management solution.**
*You may find documentation on the admin panel [here](&/admin-panel/)*