fix(docs): improve getting started self host page (#1238)
This commit is contained in:
Mo
@@ -16,28 +16,57 @@ hide_title: false
|
||||
hide_table_of_contents: false
|
||||
---
|
||||
|
||||
Our self-hosted server infrastructure consists of several different microservices that are responsible for different sets of functionality. Our self-hosted server is only intended as the backend that processes and stores your data; it does not include self-hosting the web application, which is an optional process that must be done separately. You will be able to use our existing [web](https://app.standardnotes.com) and desktop app with your self-hosted server.
|
||||
Our self-hosted server infrastructure consists of different microservices responsible for varying functionality. The self-hosted server works as the _backend_ that processes and stores your data; it does not include the web application.
|
||||
|
||||
## Get Started
|
||||
The web application is an optional process that you must spin up separately. However, you can use the [existing web app](https://app.standardnotes.com) or the official Standard Notes desktop app with your self-hosted server.
|
||||
|
||||
👉 **[Using our automated docker-compose setup with accompanying scripts](./docker.md)** 👈
|
||||
:::tip Quick start
|
||||
|
||||
If you'd like to learn more about each of the particular services, head over to [Infrastructure Overview](./infrastructure-overview.md).
|
||||
The fastest and easiest way to get up and running is to use our automated Docker setup. All you need is a Linux server and the latest version of [Docker](https://docs.docker.com/get-started).
|
||||
|
||||
> **Note** Our setup also provides a running MySQL database and a Redis cache node. You do not have to provision these services on your own. For users that have been self-hosting a legacy version of our server, we've prepared a [Migrating from Legacy guide](./legacy-migration.md).
|
||||
[Check out our Docker instructions page to get started →](./docker.md)
|
||||
|
||||
### Recommendations
|
||||
:::
|
||||
|
||||
We highly recommend you use our Docker setup to host your syncing server. Docker containers are isolated software environments that you can control and manage.
|
||||
## Infrastructure overview
|
||||
|
||||
If you are new to Docker, please see the [official Docker documentation](https://docs.docker.com/get-started) on how to get started. Ensure you [install Docker-Compose](https://docs.docker.com/compose/install/) following the documentation. Your Linux distribution may not have the most up to date docker-compose and will fail to load.
|
||||
### API Gateway
|
||||
|
||||
We recommend avoiding setting up your syncing server from scratch with Nginx unless you are proficient with Nginx. Setting up the full architecture can be challenging without full knowledge of how the syncing server and its microservices function.
|
||||
The main entry point of the architecture. The API Gateway is a router and proxy for all services which are otherwise inaccessible directly. All requests from client applications go through the API Gateway to reach a target underlying service. This service is configured with your reverse proxy for public HTTPS support.
|
||||
|
||||
### Issues
|
||||
### Syncing Server
|
||||
|
||||
If you have any issues with setting up your syncing server, please [open an issue on GitHub](https://github.com/standardnotes/standalone/issues).
|
||||
Responsible for user data and syncing operations.
|
||||
|
||||
### Syncing Server Worker
|
||||
|
||||
Responsible for asynchronous tasks the Syncing Server may offload for background processing, including email backups, revision history, and more.
|
||||
|
||||
### Auth
|
||||
|
||||
Responsible for authorization and authentication mechanisms within Standard Notes.
|
||||
|
||||
### Auth Worker
|
||||
|
||||
Responsible for asynchronous tasks related to the domain of authentication and authorization, including account deletion requests and post-registration tasks.
|
||||
|
||||
### Database
|
||||
|
||||
The database is where data is stored.
|
||||
|
||||
### Cache
|
||||
|
||||
A Redis cache node is used to store temporary data for performance optimization and auto-expiring features. In self-hosted mode, Redis is used as a communication queue between services and workers.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you run into any issues setting up your server, please [open an issue on GitHub](https://github.com/standardnotes/standalone/issues) or reach out on the [Standard Notes Discord](https://standardnotes.com/discord).
|
||||
|
||||
## Web application
|
||||
|
||||
If you would like to self-host the actual Standard Notes web application, visit the [repository for the web app on GitHub](https://github.com/standardnotes/web).
|
||||
If you would like to self-host the actual Standard Notes web application, visit the [repository for the Standard Notes web app on GitHub](https://github.com/standardnotes/app/tree/main/packages/web).
|
||||
|
||||
## Self-hosting without Docker?
|
||||
|
||||
Configuring the full Standard Notes architecture manually can be challenging without detailed study. We do not offer support for this method of self-hosting. [The only supported self-hosting method is to use Docker →](./docker.md)
|
||||
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
---
|
||||
slug: infrastructure-overview
|
||||
id: infrastructure-overview
|
||||
title: Infrastructure Overview
|
||||
sidebar_label: Infrastructure Overview
|
||||
description: Standard Notes Infrastructure Overview.
|
||||
keywords:
|
||||
- standard notes
|
||||
- docs
|
||||
- notes app
|
||||
- end-to-end encryption
|
||||
- self-hosting
|
||||
- sync server
|
||||
image: /img/logo.png
|
||||
hide_title: false
|
||||
hide_table_of_contents: false
|
||||
---
|
||||
|
||||
## Services
|
||||
|
||||
The Syncing Server infrastructure consists of a few different microservices that are responsible for different sets of functionality.
|
||||
|
||||
### Syncing Server JS
|
||||
|
||||
Syncing Server JS is a TypeScript implementation of our Syncing Server. This is the core of our business logic that is responsible for all operations on user data.
|
||||
|
||||
### Syncing Server JS Worker
|
||||
|
||||
Syncing Server JS Worker is responsible for all asynchronous tasks that the Syncing Server JS may offload for background processing. This includes for example processing of email backups, resolving issues with note duplicates, sending notes to extensions server, and more.
|
||||
|
||||
### Auth
|
||||
|
||||
This server is responsible for all authorization and authentication mechanisms. Auth is where all account-related metadata is handled and processed.
|
||||
|
||||
### Auth Worker
|
||||
|
||||
Similar to Syncing Server JS Worker, Auth Worker is responsible for all asynchronous tasks related to the domain of authentication and authorization. For example, processing account deletion requests and users' post-registration tasks.
|
||||
|
||||
### API Gateway
|
||||
|
||||
This is the main "entry point" of the entire architecture. API Gateway serves as a router and proxy to all services which are inaccessible directly. All requests from client applications will have to go through API Gateway in order to reach a certain underlying service.
|
||||
|
||||
This service will be paired with your reverse proxy for [HTTPS support](./https-support.md)
|
||||
|
||||
### DB
|
||||
|
||||
MySQL database server. This is where all data is stored.
|
||||
|
||||
### Cache
|
||||
|
||||
Redis cache node where all temporary data is persisted for performance optimization and auto-expiring features.
|
||||
|
||||
In self-host mode, Redis is used by default as a communication queue between services and their workers.
|
||||
@@ -4,7 +4,6 @@ module.exports = {
|
||||
{
|
||||
'Self Hosting': [
|
||||
'self-hosting/getting-started',
|
||||
'self-hosting/infrastructure-overview',
|
||||
'self-hosting/docker',
|
||||
'self-hosting/configuration-options',
|
||||
'self-hosting/legacy-migration',
|
||||
|
||||
Reference in New Issue
Block a user