mirror of
https://github.com/janishutz/libreevent.git
synced 2025-11-25 05:14:23 +00:00
move to new, correct name
This commit is contained in:
@@ -3,7 +3,7 @@ The main website's pages are written in HTML & CSS whilst the doc pages are auto
|
||||
** DO NOT MODIFY THE DOC PAGES IN THE [dist/docs/](dist/docs/) DIRECTORY! **
|
||||
|
||||
## Links in the md files in [src/](src/)
|
||||
Please note that you are required to use either a link relative to the root folder with double forward slash (example: *//server/app.js*), to the website root with a single forward slash (example: */download*), to the docs root with &/ (example: *&/setup*) or simply /docs/ (example: */docs/setup*), a full link (example: *https://myevent.janishutz.com/docs*) or a relative link (example: *plugins/music*). If you do not follow these patterns, the website won't build or the links will not work correctly.
|
||||
Please note that you are required to use either a link relative to the root folder with double forward slash (example: *//server/app.js*), to the website root with a single forward slash (example: */download*), to the docs root with &/ (example: *&/setup*) or simply /docs/ (example: */docs/setup*), a full link (example: *https://libreevent.janishutz.com/docs*) or a relative link (example: *plugins/music*). If you do not follow these patterns, the website won't build or the links will not work correctly.
|
||||
|
||||
***NOTE: Don't be confused if the root folder links don't work in the Markdown, as they use specific syntax for the build script.***
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* myevent - build.js
|
||||
* libreevent - build.js
|
||||
*
|
||||
* Created by Janis Hutz 03/09/2023, Licensed under the GPL V3 License
|
||||
* https://janishutz.com, development@janishutz.com
|
||||
|
||||
2
website/dist/about/index.html
vendored
2
website/dist/about/index.html
vendored
@@ -7,7 +7,7 @@
|
||||
<link rel="stylesheet" href="/css/style.css">
|
||||
<link rel="stylesheet" href="/css/home.css">
|
||||
<title>About :: libreǝvent</title>
|
||||
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? myevent is a project that does exactly that.">
|
||||
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
|
||||
</head>
|
||||
<body>
|
||||
<div id="nav"></div>
|
||||
|
||||
2
website/dist/css/home.css
vendored
2
website/dist/css/home.css
vendored
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* myevent - home.css
|
||||
* libreevent - home.css
|
||||
*
|
||||
* Created by Janis Hutz 03/05/2023, Licensed under the GPL V3 License
|
||||
* https://janishutz.com, development@janishutz.com
|
||||
|
||||
2
website/dist/css/navstyle.css
vendored
2
website/dist/css/navstyle.css
vendored
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* myevent - navstyle.css
|
||||
* libreevent - navstyle.css
|
||||
*
|
||||
* Created by Janis Hutz 03/06/2023, Licensed under the GPL V3 License
|
||||
* https://janishutz.com, development@janishutz.com
|
||||
|
||||
2
website/dist/css/style.css
vendored
2
website/dist/css/style.css
vendored
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* myevent - style.css
|
||||
* libreevent - style.css
|
||||
*
|
||||
* Created by Janis Hutz 03/05/2023, Licensed under the GPL V3 License
|
||||
* https://janishutz.com, development@janishutz.com
|
||||
|
||||
4
website/package-lock.json
generated
4
website/package-lock.json
generated
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "myevent-website",
|
||||
"name": "libreevent-website",
|
||||
"version": "1.0.0",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "myevent-website",
|
||||
"name": "libreevent-website",
|
||||
"version": "1.0.0",
|
||||
"license": "GPL-3.0-or-later",
|
||||
"dependencies": {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# 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.
|
||||
The admin panel is where you can change basically everything about libreevent. 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)
|
||||
|
||||
@@ -10,7 +10,7 @@ On this page you may add, modify or remove admin accounts. Note that in order fo
|
||||
|
||||
|
||||
### 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.
|
||||
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
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Settings
|
||||
|
||||
## 2FA
|
||||
myevent offers two different 2fa modes:
|
||||
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.
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
# myevent - documentation
|
||||
Welcome to the myevent documentation! Here you may learn how to set up a myevent-server instance, how to configure it and how to install plugins. You may also learn how to develop your own plugin and what you need to know if you want to contribute to the project.
|
||||
# libreevent - documentation
|
||||
Welcome to the libreevent documentation! Here you may learn how to set up a libreevent-server instance, how to configure it and how to install plugins. You may also learn how to develop your own plugin and what you need to know if you want to contribute to the project.
|
||||
@@ -1,2 +1,2 @@
|
||||
# Setup
|
||||
In this tutorial, you are going to learn how to set up and configure myevent.
|
||||
In this tutorial, you are going to learn how to set up and configure libreevent.
|
||||
@@ -1,9 +1,9 @@
|
||||
# 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!
|
||||
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 [here](https://api.janishutz.com/contact/setup?origin=libreevent&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.*
|
||||
Choosing the right hosting provider is not easy, especially since libreevent 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/
|
||||
@@ -17,7 +17,7 @@ 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?
|
||||
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 works perfectly fine.
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# 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!
|
||||
# Setup of libreevent
|
||||
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 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".
|
||||
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".
|
||||
|
||||
*Note: This is only available during the setup process of myevent and will afterwards be deactivated to ensure safety of the system.*
|
||||
*Note: This is only available during the setup process of libreevent and will afterwards be deactivated to ensure safety of the system.*
|
||||
|
||||
## Root account
|
||||
This is the most powerful account in this system. From it you can control EVERY aspect of your system.
|
||||
@@ -22,7 +22,7 @@ Special characters | At least 2 required
|
||||
Numbers | At least 2 required
|
||||
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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
@@ -37,12 +37,12 @@ Now it is time to set up some payment methods. You may find advantages / disadva
|
||||
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.
|
||||
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).
|
||||
|
||||
|
||||
**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).**
|
||||
**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 may find documentation on the admin panel [here](&/admin-panel/)*
|
||||
@@ -1,5 +1,5 @@
|
||||
# Systemrequirements
|
||||
myevent's system requirements are low, you only need a PC or Server that can run node.js and is able to install npm packages. If the system you are trying to use is unable to download npm packages, you may download the packages on your own system and upload them together with the rest of the server files. How to do that is described in greater detail in the [Getting Started guide](/docs/gettingStarted).
|
||||
libreevent's system requirements are low, you only need a PC or Server that can run node.js and is able to install npm packages. If the system you are trying to use is unable to download npm packages, you may download the packages on your own system and upload them together with the rest of the server files. How to do that is described in greater detail in the [Getting Started guide](/docs/gettingStarted).
|
||||
|
||||
## node.js
|
||||
Your system needs to be able to run node.js V > 12.0 and must have access to either npm or the downloaded npm packages.
|
||||
|
||||
Reference in New Issue
Block a user