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

doc updates

Browse Source
This commit is contained in:
janis
2023-09-18 10:11:58 +02:00
parent 9c8278df37
commit 5c6f189396
13 changed files with 165 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
website/src/admin-panel/settings.md
View File

@@ -1,28 +1,38 @@
# Settings
## 2FA
libreevent offers two different 2fa modes:
- 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.
- 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.
You can require the users to enable Two-Factor Authentication when confirming their email.
The following settings are available:
In both modes, the system informs the user about the IP address that tried to log into the account.
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'.
## User account passwords
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.
Setting | Explanation
----------------|-----------
always require | Always require the user to use Two-Factor Authentication (will be enforced at account confirmation)
user can decide | Allow the user to decide if they want to enable Two-Factor Authentication (default, recommended)
disable | Disable Two-Factor-Authentication entirely (only for users, root account still has 2FA enforced!)
## Change organisation name
This should be self explanatory, but keep in mind that this change will only take effect after the next restart of the node app.
## Currency
This setting allows you to change the currency in which you want your customers to pay. The code has to be a valid ISO 4217 currency code. See more [here](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) (Wikipedia). This setting defaults to USD.
## Ticket Timeout
The ticket timeout setting allows you to specify for how much time of inactivity the ticket is reserved for a user. The value is to be entered in seconds. The database is parsed every five minutes by default (can be changed in the config file) and, if the threshold set here is exceeded, the session is garbage collected and all tickets selected are returned to the available tickets pool.
## Payment gateway
### Select a gateway
With this setting, you can select the payment gateway to use. You may follow the link [here](https://libreevent.janishutz.com/docs/payments) to get more information on the payment gateway. You need to hit save to enable editing for the gateway settings.
### Gateway settings
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
# Admin Accounts
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.
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.-->
## Adding an account
### Privileges
<!-- ### 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:
Group | Allowed settings
@@ -30,17 +40,31 @@ Group | Allowed settings
Root | All pages. Can only be one account (the root account)
Admin | Can access all pages and settings except for Admin Accounts
Event-Manager | Access the events & pages page
Event-Handler | Can log into the apps to do entry control
Event-Handler | Can log into the apps to do entry control -->
### Username
Give the user a username that can be used for internal recognition. It does not currently have any other use.
### Email
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.
An email address is required to allow the user to log in (it's their username) and for Two-Factor-Authentication.
### Password
The password of the admin account does not have any specific requirements (yet), but we strongly encourage you to follow these guidelines:
Factor | Requirement
--------------------|--------------------------------------------------
Length | At least 15 characters
Special characters | At least 2 required
Numbers | At least 2 required
Upper / Lower case | At least 2 upper & 2 lower case letters required
### 2FA
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 [Settings](&/admin-panel/settings#2fa) you may choose between the two different 2FA modes that libreevent offers.
With this setting, you can choose one of three Two-Factor-Authentication modes, namely, disabled for no 2FA, Simple for one where the user has to verify the login by clicking a link in an email sent to them or Enhanced for one where the user has to enter a code after having opened up the link in the email sent to them.
## Modifying an account
You can update the username and the password of any admin account by clicking onto it.
## Removing an account
## Removing an account
You can delete an admin account by right clicking on it (yes, right click) and hit delete. Confirm again that you want to delete the account and then it's gone.

3
website/src/payments.md
View File

@@ -1,10 +1,11 @@
# Payments
Including many payment methods can help the user choose the one that fits them best, but can also be overwhelming and a pain to set up. So please try to use as few different payment gateways as possible. Officially, libreevent supports *Stripe* and *Payrexx*. More payment gateways might come in the future as a plugin which can be installed by following our guide [here](&/plugins/install#payments)
Please use our cost efficiency calculator [here](&/payments/cost-efficiency-calculator) to see which is best suited for you.
## Advantages / Disadvantages of each payment gateway
### payrexx
Payrexx is a Swiss, lesser known payment gateway and it is not ideal for you if you expect to have a low sales volume, as their basic plan costs you EUR 15 a month. If your sales volume is fairly high, it may be worth it as their per-transaction fees are quite a bit lower than Stripe's and they offer more payment options.
Payrexx is a Swiss payment gateway and it features a massive variety in payment methods, ranging from various kinds of credit cards all the way to specific online payment methods. See all their payment methods [here](https://payrexx.com/en/paymentmethods).
See payrexx [pricing here](https://www.payrexx.com/en/pricing/) and sign up [here](https://signup.payrexx.com). You can find a full list of supported payment methods [here](https://payrexx.com/en/paymentmethods)
### Stripe