Compare commits
5 Commits
84a895d82b
...
50b325393f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
50b325393f | ||
|
|
4d31d6173a | ||
|
|
fa16147847 | ||
|
|
1dd1521919 | ||
|
|
e82c38f7e0 |
11
Getting Started.md
Normal file
11
Getting Started.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
After [[Installation|installing]] Sentri, it is recommended to review the initial configuration settings.
|
||||||
|
# Reset superuser password
|
||||||
|
First, make sure to reset the superuser password.
|
||||||
|
# Global settings
|
||||||
|
Go to [[Portal Management/Global|Global]] under Portal Management and rename the portal to your preference.
|
||||||
|
|
||||||
|
Next, configure the SMTP connection in [[Portal Management/Mail|Mail]] under Portal Management so Sentri can send emails.
|
||||||
|
|
||||||
|
Finally, enable the [[index#Modules|modules]] you want to use in [[Portal Management/Modules|Modules]] under Portal Management.
|
||||||
|
# Create users and check permissions
|
||||||
|
Create administators and set the right permissions.
|
||||||
71
Installation.md
Normal file
71
Installation.md
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
This guide explains how to install Sentri on a Linux server.
|
||||||
|
# Requirements
|
||||||
|
Before continuing, make sure your server meets the following requirements:
|
||||||
|
- A Linux server (Linux is officially tested and supported)
|
||||||
|
- Basic Linux and web hosting experience
|
||||||
|
- A web server of your choice (Apache, Nginx, Caddy, etc.)
|
||||||
|
- MariaDB or MySQL
|
||||||
|
- PHP 8.3 or newer
|
||||||
|
- Git installed on the server
|
||||||
|
|
||||||
|
>[!info]
|
||||||
|
>This guide uses `/var/www/sentri/` as the installation directory. You can change this to any location you prefer.
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
## Configure the document root
|
||||||
|
Sentri stores all publicly accessible files inside the `pub/` directory.
|
||||||
|
If your current virtual host document root is:
|
||||||
|
```
|
||||||
|
/var/www/sentri/
|
||||||
|
```
|
||||||
|
Change it to:
|
||||||
|
```
|
||||||
|
/var/www/sentri/pub/
|
||||||
|
```
|
||||||
|
After updating the document root, reload or restart your web server.
|
||||||
|
## Download the Sentri files
|
||||||
|
Run the following commands to download the latest version of Sentri:
|
||||||
|
```bash
|
||||||
|
cd /var/www/sentri/
|
||||||
|
|
||||||
|
git clone https://gitea.mooij.me/meteo/Sentri.git Sentri
|
||||||
|
|
||||||
|
mv Sentri/* .
|
||||||
|
mv Sentri/.[!.]* . 2>/dev/null
|
||||||
|
|
||||||
|
rmdir Sentri
|
||||||
|
```
|
||||||
|
## Database setup
|
||||||
|
Log in to MariaDB/MySQL and create the database and user:
|
||||||
|
```sql
|
||||||
|
CREATE DATABASE sentri;
|
||||||
|
CREATE USER 'sentri'@'localhost' IDENTIFIED BY 'your_secure_password_here';
|
||||||
|
GRANT ALL PRIVILEGES ON sentri.* TO 'sentri'@'localhost';
|
||||||
|
FLUSH PRIVILEGES;
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, import the database schema:
|
||||||
|
```bash
|
||||||
|
mariadb -u sentri -p sentri < /var/www/sentri/install.sql
|
||||||
|
```
|
||||||
|
When prompted, enter the password for the `sentri` database user.
|
||||||
|
## Configuring
|
||||||
|
Copy the example configuration file:
|
||||||
|
```bash
|
||||||
|
cp /var/www/sentri/pub/config-sample.php /var/www/sentri/pub/config.php
|
||||||
|
```
|
||||||
|
Then edit the configuration file and update the database credentials:
|
||||||
|
```
|
||||||
|
/var/www/sentri/pub/config.php
|
||||||
|
```
|
||||||
|
# First Login
|
||||||
|
Open your website in a browser and log in with the default credentials:
|
||||||
|
```
|
||||||
|
Username: superuser
|
||||||
|
Password: changethispassword
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> After logging in change the superuser password!
|
||||||
|
# Getting started
|
||||||
|
After completing the installation, continue with the [[Getting Started]] guide to configure and begin using Sentri.
|
||||||
1
Portal Management/Global.md
Normal file
1
Portal Management/Global.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
To be made.
|
||||||
1
Portal Management/Mail.md
Normal file
1
Portal Management/Mail.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
To be made.
|
||||||
1
Portal Management/Modules.md
Normal file
1
Portal Management/Modules.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
To be made.
|
||||||
@@ -29,14 +29,15 @@
|
|||||||
- Problem with sorting backups types in the server overview
|
- Problem with sorting backups types in the server overview
|
||||||
## Roadmap
|
## Roadmap
|
||||||
- Be able to configure sources for certain tasks
|
- Be able to configure sources for certain tasks
|
||||||
- More configuration options for sources.
|
|
||||||
- Make the /login page the same style as the rest of Sentri.
|
- Make the /login page the same style as the rest of Sentri.
|
||||||
- Light mode theme.
|
- Light mode theme.
|
||||||
- Travel cost page.
|
- Travel cost page.
|
||||||
- VM hosts overview.
|
- Hypervisor overview.
|
||||||
- Add name to API tokens.
|
- Add name to API tokens.
|
||||||
- Loggin of actions to local storage or to things such as graylog.
|
- Logging of actions to local storage or to things such as graylog.
|
||||||
- SSO/SAML/User provisioning.
|
- SSO/SAML/User provisioning.
|
||||||
|
- Test email settings button.
|
||||||
|
- Docker container.
|
||||||
|
|
||||||
## v0.1
|
## v0.1
|
||||||
`23-12-2024`
|
`23-12-2024`
|
||||||
|
|||||||
37
index.md
37
index.md
@@ -1,8 +1,39 @@
|
|||||||
# Welcome to the Sentri wiki!
|
# Welcome to the Sentri wiki!
|
||||||
|
>[!note]
|
||||||
|
>The making of the this documentation is still in progress.
|
||||||
|
# What is Sentri
|
||||||
|
Sentri is a self-hosted web application built around a modular system. Each module provides a specific feature or solves a particular use case, and was created from practical needs encountered throughout my career as a system and network administrator. Instead of relying on multiple separate services or portals for smaller operational tasks, Sentri centralizes them into a single fast, lightweight, and manageable platform.
|
||||||
|
|
||||||
The making of the this documentation is still in progress.
|
Its modular structure keeps the platform lightweight and flexible by allowing you to enable only the components you actually use. Sentri is open-source, performance-focused, and designed to remain minimal and simple. Because Sentri is fully self-hosted, all data remains under your control without depending on third-party providers.
|
||||||
|
|
||||||
This wiki explains how Sentri works. If anything is missing or unclear in this documentation, please let me know.
|
Sentri is released under the Apache License, Version 2.0.
|
||||||
|
# Modules
|
||||||
|
Sentri includes these modules that can be enabled or disabled at any time, so you only see and use the functionality you need.
|
||||||
|
## Module: Portal Management
|
||||||
|
Always enabled. This module is used to manage Sentri’s core settings and configuration. Its also used to configure different sources.
|
||||||
|
## Module: Customers
|
||||||
|
This module is used to store companies from your CRM inside Sentri, allowing you to link them to items across different modules.
|
||||||
|
|
||||||
Documentation written by Marco Mooij
|
The following CRM customer sources are currently available:
|
||||||
|
- [[Portal Management/Sources/Inserve|Inserve]]
|
||||||
|
## Module: Office
|
||||||
|
This module currently provides a playful feature that lets you “stomp” a colleague. It can be used to keep track of things such as counting your mom jokes or other actions between team members. These events are trackable and visualized through a simple graph.
|
||||||
|
## Module: Servers
|
||||||
|
The Servers module is designed to help you keep track of all servers you manage. It centralizes key information such as assigned resources, configured backups, used licenses, and more.
|
||||||
|
|
||||||
|
This data can be pushed to Sentri via [[API/v1/servers/POST Create or update server|this API endpoint]] using your own scripts or automation.
|
||||||
|
|
||||||
|
Once centralized, server information can be shared with external sources, such as:
|
||||||
|
- [[Portal Management/Sources/Inserve|Inserve]]
|
||||||
|
- Automatically creates and updates cloud distributor licenses for invoicing
|
||||||
|
- Automatically creates and updates subscriptions for invoicing
|
||||||
|
## Module: Autoprovisioning
|
||||||
|
> [!Note]
|
||||||
|
> This module is under contruction and far from complete
|
||||||
|
|
||||||
|
The Autoprovisioning module is used to manage configuration settings for devices such as Yealink phones. Full device configurations are generated dynamically when requested through Yealink autoprovisioning. This makes the configuring of Yealink phones extremly flexible.
|
||||||
|
# Getting Started
|
||||||
|
You can find the installation guide [[Installation|here]].
|
||||||
|
To get started, follow [[Getting Started|this guide]].
|
||||||
|
# Sources
|
||||||
|
Sentri allows external data sources to integrate and synchronize information into and out of the the system. Currently, Inserve is the only supported source. When the time and need comes additional sources will be added.
|
||||||
Reference in New Issue
Block a user