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

add some more documentation

Browse Source
This commit is contained in:
Janis Hutz
2023-07-28 09:38:53 +02:00
parent b8b6467633
commit 0ef138c865
4 changed files with 43 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
website/src/admin-panel/admin-accounts.md
View File

@@ -1,27 +0,0 @@
# 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.
## Adding an account
### Privileges
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
----------------|------------------
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
### 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.
### 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.
## Modifying an account
## Removing an account

11
website/src/admin-panel/events.md
View File

@@ -11,4 +11,13 @@ This is the name that is being displayed when users are browsing your events. Ca
Describe what your event is about. It will be displayed underneath the event name when users are browsing your events. In the browsing view, the length of the description is limited to 150 characters, after which three dots will be added to the text and a 'continue reading' button will be added. Technically, there's no limit to the length of the event description, but don't overdo it with the length, as the user is unlikely to read more than a couple words anyway. Describe what your event is about. It will be displayed underneath the event name when users are browsing your events. In the browsing view, the length of the description is limited to 150 characters, after which three dots will be added to the text and a 'continue reading' button will be added. Technically, there's no limit to the length of the event description, but don't overdo it with the length, as the user is unlikely to read more than a couple words anyway.
### Event location ### Event location
Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide [here](&/admin-panel/seatplan-editor) Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide [here](&/admin-panel/seatplan-editor)
## Guest purchase
Choose if a user may purchase a ticket without creating an account. An email address is always required as the system sends the tickets via email to the customers for easier access.
## Allow overbooking
Activate this and set a percentage of overbooking, if you want to enable overbooking of the event to ensure that every single spot is occupied even if somebody does not show up. Use is strongly discouraged and currently only works with events that have no seating plan.
## Special requirements
Here you may set a special requirement that a person booking a ticket has to fulfill, like the email address has to be ending in @yourdomain.com or they need to live in a certain street / town / city / country in order for them to be allowed to buy a ticket. You may also require that they provide a certain number, code or similar. Finally, you may choose to limit the amount of tickets a single person may reserve.

3
website/src/admin-panel/locations.md Normal file
View File

@@ -0,0 +1,3 @@
# Locations
libreevent allows you to create an infinite amount of locations where you can host events in. These locations all can have a seat plan - or not. This is entirely your choice. You may use libreevent's powerful seat plan editor to edit the seat plan if you choose to add one. All of the locations can be assigned to one or multiple events such that you do not waste any time creating seat plans when it is not necessary.

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

@@ -12,15 +12,35 @@ This setting can be changed individually for admin and user accounts and 2FA can
## User account passwords ## 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. 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.
## Guest purchase
Choose if a user may purchase a ticket without creating an account. An email address is always required as the system sends the tickets via email to the customers for easier access.
## Allow overbooking
Activate this and set a percentage of overbooking, if you want to enable overbooking of the event to ensure that every single spot is occupied even if somebody does not show up. Use is strongly discouraged and currently only works with events that have no seating plan.
## Special requirements
Here you may set a special requirement that a person booking a ticket has to fulfill, like the email address has to be ending in @yourdomain.com or they need to live in a certain street / town / city / country in order for them to be allowed to buy a ticket. You may also require that they provide a certain number, code or similar. Finally, you may choose to limit the amount of tickets a single person may reserve.
## Change organisation name ## 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. This should be self explanatory, but keep in mind that this change will only take effect after the next restart of the node app.
# 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.
## Adding an account
### Privileges
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
----------------|------------------
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
### 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.
### 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.
## Modifying an account
## Removing an account