lost of progress

This commit is contained in:
2023-04-21 16:03:21 +02:00
parent 13924e3abb
commit 8d751026b6
26 changed files with 483 additions and 47 deletions

View File

@@ -0,0 +1,11 @@
# Admin panel
The admin panel is where you can change basically everything about myevent. Depending on your account's privileges, you may find more or less settings. Only the root account has access to the admin accounts page.
Here's a list of the pages available when logged in as the root user. All other users have fewer pages enabled.
- [Admin Accounts](&/admin-panel/admin-accounts)
- [Pages](&/admin-panel/pages)
- [Events](&/admin-panel/events)
- [Plugins](&/admin-panel/plugins)
- [Settings](&/admin-panel/settings)
Additionally, some settings might not be available to all admin accounts on all pages.

View File

@@ -0,0 +1,18 @@
# 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
### Email
### 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 myevent offers.
## Modifying an account
## Removing an account

View File

View File

View File

View File

@@ -0,0 +1,26 @@
# Settings
## 2FA
myevent 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.
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.
## 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
This should be self explanatory, but keep in mind that this change will only take effect after the next restart of the node app.

7
website/src/errors.md Normal file
View File

@@ -0,0 +1,7 @@
# Errors
## 404
A 404 error is returned if the page was not found on the server. This can be either due to a wrong link or a badly configured server, but is mostly user error, so a misspelled link.
## 500
An internal server error occurs when the server is unable to properly process a request, which in some cases might also return a [400](#400) error, if the server first decides that the request is unacceptable.

View File

@@ -0,0 +1,15 @@
# 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. Our recommendation is either *Stripe* or *adyen* as they are the most flexible.
## Advantages / Disadvantages of each payment gateway
### Stripe
Stripe is one of the most well known payment gateways out there, but is also fairly expensive, but easy to set up.
See [here](https://stripe.com/en-gb/pricing) for pricing information and sign up [here](https://dashboard.stripe.com/register)
### adyen
Adyen is used by small and huge businesses alike, but you have to email their support team for account creation, which is easy to do, but takes longer to complete. adyen is fairly cheap, "*only*" charging 0.10$ per transaction plus payment method costs. Detailed pricing information can be found [here](https://www.adyen.com/pricing) and you may sign up [here](https://www.adyen.com/contact/sales)
### payrexx
https://www.payrexx.com/en/pricing/

View File

@@ -0,0 +1,26 @@
# Installation
Let's begin with setting up myevent! If you are not technically savvy or want somebody else to set it up for you, please contact me [here](https://api.janishutz.com/contact/setup?origin=myevent&campaign=installation-docs). If you want to set it up yourself, read on below!
# Selecting a webhosting company
Choosing the right hosting provider is not easy, especially since myevent requires node.js. Therefore, we've listed a few really good options. This website here is hosted by asurahosting. *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.*
https://clients.asurahosting.com/aff.php?aff=1997
https://www.novatrend.ch/en/
https://www.hostinger.com/
https://www.a2hosting.com/
https://www.hetzner.com/
https://www.digitalocean.com/
*Affiliate program*
https://affiliates.hostinger.com/users/signup/
https://www.a2hosting.com/about/affiliate-program/
https://www.digitalocean.com/go/affiliates
## Database
In the database, all the userdata is stored. myevent 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 works perfectly fine.
- 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 which is much more reliable and if you lose access to the database, you can only access the root account and all other data (and therefore all user accounts) is lost.*
MySQL generally is more difficult to set up, but we'll run you through the process here to make the process easier for you. If you chose the JSON based database, skip ahead to the next chapter.

View File

@@ -1,16 +1,12 @@
# Setup of myevent
At this point we assume you've completed the initial install of myevent. 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!
At this point we assume you've completed the initial install of myevent. 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 myevent post-install landing page. Please click onto the button saying 'To the admin panel' and log in with the following credentials:
Username: setup
Password: myevent-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 myevent 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".
*Note: This is only available during the setup process of myevent and will afterwards be deactivated to ensure safety of the system.*
## Setting up the root account
## Root account
This is the most powerful account in this system. From it you can control EVERY aspect of your system.
**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**
@@ -28,8 +24,25 @@ Upper / Lower case | At least 2 upper & 2 lower case letters required
Please avoid using easy to guess combinations like names & birth dates of you or your relatives, zip codes & cities and obvious words like 'password', 'myevent', 'admin', 'root' and your organisation / event's name.
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 if you choose to add a homepage. If you selected a homepage, you have to insert a promotional text and you have to select a homepage-template from one that is available [here](/homepage/templates). You also have to upload some images at this stage.
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.
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 myevent 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).
**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: myevent.janishutz.com/admin, replace myevent.janishutz.com with your own domain).**
*You may find documentation on the admin panel [here](&/admin-panel/)*