github/oneuptime
1
1
Fork 0
mirror of https://github.com/OneUptime/oneuptime.git synced 2026-04-06 00:32:12 +02:00
Code Issues 193 Packages Projects Releases Wiki Activity

change fyipe to oneuptime and fyipe.com to oneuptime.com for docs

Browse Source
This commit is contained in:
deityhub
2021-11-22 11:52:09 +01:00
parent b05b6aa867
commit 768bf65a67
9 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/alert_rules.md
View File

@@ -7,7 +7,7 @@
Rules order
</th>
<th colspan="2">
Fyipe level configurations
OneUptime level configurations
</th>
<th colspan="2">
Project level configurations

16
docs/architecture.md
View File

@@ -10,7 +10,7 @@ The main part of the project are:
### User interfaces
Fyipe has four separated projects for the UI:
OneUptime has four separated projects for the UI:
#### accounts
@@ -40,7 +40,7 @@ The backend is the heart of the project. In addition to collecting the data from
In addition to the three main components, we have the server monitor. This is an agent that needs to be installed in all the servers that will be monitored. Its main task is to collect data, like remaining storage space and CPU load, and to provide them to the probe server when requested.
The following diagram describes the general architecture of the Fyipe project.
The following diagram describes the general architecture of the OneUptime project.
![](./fyipe_architecture.png)
@@ -55,8 +55,8 @@ Using the admin dashboard, the administrator will be able to :
- Manage probe servers,
- Check the audit logs,
- Update the software license,
- Configure the SMTP server to enable Fyipe sending emails like alerts, invitation, verifications, etc...
- Configure Twilio account to enable Fyipe sending alerts SMS/calls,
- Configure the SMTP server to enable OneUptime sending emails like alerts, invitation, verifications, etc...
- Configure Twilio account to enable OneUptime sending alerts SMS/calls,
- Configure single sign-on domains to allow users to authenticate using third-party identity providers.
### User accounts
@@ -91,17 +91,17 @@ The user can create many status pages. For each page, he can select the resource
#### Reports
Fyipe generates several reports related to the incidents, the average resolve time, and monitors.
OneUptime generates several reports related to the incidents, the average resolve time, and monitors.
#### Inviting members
The user can invite by the email other users to join the team.
![](./user_environment.png)
## Fyipe in production
## OneUptime in production
Fyipe can be deployed in one of two modes: SAAS mode and enterprise mode. SAAS is the mode used by Hackerbay to run Fyipe. The clients can create accounts without being administrators or having access to the admin dashboard.
In enterprise mode, the client will have the fyipe code deployed on his personal servers.
OneUptime can be deployed in one of two modes: SAAS mode and enterprise mode. SAAS is the mode used by Hackerbay to run OneUptime. The clients can create accounts without being administrators or having access to the admin dashboard.
In enterprise mode, the client will have the oneuptime code deployed on his personal servers.
The running mode needs to be configured on the following subprojects, by updating the .env file in each of them, as the behavior of some of their features may change depending on the mode.

12
docs/concept.md
View File

@@ -1,9 +1,9 @@
# Concept.
# Concept.
Please read Fyipe public website (https://fyipe.com).
You can also run fyipe website locally by running
Please read OneUptime public website (https://oneuptime.com).
You can also run oneuptime website locally by running
- `npm install` and
- `npm start`
- `npm install` and
- `npm start`
inside of the `home` folder of this project.
inside of the `home` folder of this project.

8
docs/dns.md
View File

@@ -1,7 +1,7 @@
# DNS
Here are all the active DNS we use in prodiction:
- fyipe.com / www.fyipe.com: For helm production service.
- staging.fyipe.com: For staging service.
- charts.fyipe.com: Linked to fyipe.com | www.fyipe.com but used specifically for helm charts.
Here are all the active DNS we use in prodiction:
- oneuptime.com / www.oneuptime.com: For helm production service.
- staging.oneuptime.com: For staging service.
- charts.oneuptime.com: Linked to oneuptime.com | www.oneuptime.com but used specifically for helm charts.

6
docs/how-fyipe-works-overview.md
View File

@@ -1,8 +1,8 @@
# How Fyipe Works
# How OneUptime Works
## The overview of how Fyipe works
## The overview of how OneUptime works
One of the main purpose of Fyipe is to monitor resources. The flow of how this is done is depicted in the flowchart below.
One of the main purpose of OneUptime is to monitor resources. The flow of how this is done is depicted in the flowchart below.
## Description

8
docs/introduction.md
View File

@@ -1,12 +1,12 @@
# Introduction
Fyipe is one complete SRE and DevOps platform.
OneUptime is one complete SRE and DevOps platform.
Fyipe lets you do:
OneUptime lets you do:
**Monitoring:** Monitors your website, web apps, APIs, servers and more and give you detailed metrics of things that might be wrong with your infrastructure.
**Status Page:** Fyipe gives you a beautiful and customizable status page for your online business which helps improve transparency with your customers and cuts support costs.
**Status Page:** OneUptime gives you a beautiful and customizable status page for your online business which helps improve transparency with your customers and cuts support costs.
**Tests:** Write automated tests for your website, API's and more and know instantly when they start failing.
@@ -14,4 +14,4 @@ Fyipe lets you do:
**Performance Monitoring:** Monitor the performance of your apps, servers, APIs, and more and alert your team when any of your performance metrics degrades.
**Website:** https://fyipe.com
**Website:** https://oneuptime.com

22
docs/project-description.md
View File

@@ -1,21 +1,21 @@
# Description of the subprojects in this repo.
- `accounts` - A React project used for Authentication (Log in, Sign up, Forgot Password, etc.)
- `dashboard` - A React project for Fyipe user where user can interact with the Fyipe platform.
- `dashboard` - A React project for OneUptime user where user can interact with the OneUptime platform.
- `admin-dashobard` - React Project where admin can block users, delete projects and more.
- `api-docs` - HTML/CSS project. A public reference of Fyipe documentation.
- `backend` - NodeJS Service. It's Fyipe API's.
- `home` - HTML/CSS. Home Page / Marketing page of Fyipe.
- `http-test-server` - A test server used to test website monitors for Fyipe.
- `api-docs` - HTML/CSS project. A public reference of OneUptime documentation.
- `backend` - NodeJS Service. It's OneUptime API's.
- `home` - HTML/CSS. Home Page / Marketing page of OneUptime.
- `http-test-server` - A test server used to test website monitors for OneUptime.
- `ci` - DevOps/CI/CD scripts.
- `marketing` - This is where you'll find logos, brief description of Fyipe, etc.
- `marketing` - This is where you'll find logos, brief description of OneUptime, etc.
- `certifications` - SOC/ISO/PCI certifications and more.
- `postman-collection` - Postman collection for Fyipe API.
- `postman-collection` - Postman collection for OneUptime API.
- `probe` - Probe is an agent that gets installed on a third party server on a thir party datacenter and it monitors users websites, services, from that data center. You can deploy multiple probes to monitor users resources - A probe in a datacenter in EU, in US, etc.
- `server-monitor` - A probe that gets installed on a server and that monitors that particular server.
- `tests` - Smoke test that is executed after Fyipe is deployed to staging or production. If smoke test fails, the staging / production deployment will automatically be rolled back.
- `status-page` - React project - Status page project of Fyipe.
- `zapier` - Fyipe integrates with zapier. This is where integration code is. This gets deployed to zapier directly.
- `tests` - Smoke test that is executed after OneUptime is deployed to staging or production. If smoke test fails, the staging / production deployment will automatically be rolled back.
- `status-page` - React project - Status page project of OneUptime.
- `zapier` - OneUptime integrates with zapier. This is where integration code is. This gets deployed to zapier directly.
- `init-script` - a container that runs schema migration script.
- `helm-chart` - Helm Chart Scripts for installation of Fyipe into Kubernetes.
- `helm-chart` - Helm Chart Scripts for installation of OneUptime into Kubernetes.
- `kubernetes` - Values of Kubenrets env

4
docs/run.md
View File

@@ -1,9 +1,9 @@
# Running Fyipe
# Running OneUptime
## Running this project in local environment
- Watch https://youtu.be/erAxgSMkW58
- You can run Enterprise mode by `npm run dev`. Enterprise runs Fyipe service without Stripe card payments.
- You can run Enterprise mode by `npm run dev`. Enterprise runs OneUptime service without Stripe card payments.
- You can run SaaS Mode by `npm run saas-dev`. SaaS mode will enable card payments by stripe.
- You can run a parcular service by passing --service flag. For example `npm run dev --service="backend"` or multiple services by `npm run dev --service="backend accounts"`.

6
docs/running-tests.md
View File

@@ -11,7 +11,7 @@ There are two types of tests,
### SaaS tests
This runs the application in SaaS mode. What is SaaS mode? SaaS mode enables plans and pricing with stripe. It runs the test as if its a hosted Fyipe service on Fyipe.com.
This runs the application in SaaS mode. What is SaaS mode? SaaS mode enables plans and pricing with stripe. It runs the test as if its a hosted OneUptime service on oneuptime.com.
#### Running tests in SaaS mode
@@ -19,7 +19,7 @@ This runs the application in SaaS mode. What is SaaS mode? SaaS mode enables pla
npm run docker-saas-test
```
This spins up a new local Fyipe cluster on Docker Compose and runs a test on it.
This spins up a new local OneUptime cluster on Docker Compose and runs a test on it.
### Enterprise tests
@@ -31,7 +31,7 @@ This runs the application in Enterprise mode. What is Enterprise mode? Enterpris
npm run docker-enterprise-test
```
This spins up a new local Fyipe cluster on Docker Compose and runs a test on it.
This spins up a new local OneUptime cluster on Docker Compose and runs a test on it.
### Debugging tests