Skip to content

Ecosystem of servers for Standard Notes; fully self-hosted with MariaDB.

License

Notifications You must be signed in to change notification settings

juanico10/server-mariadb

 
 

Repository files navigation

Server applications using Docker compose and MariaDB

👉 I will update as soon as possible with more information.

Table of contents

Docker version

Latest version of docker updated by its developer.

Standard Notes

Docker Image Version (tag latest semver)

Localstack

Docker Image Version (tag latest semver)

Latest release app

GitHub release (with filter)

Monitoring web app

Website

Requirements

Can I self-host Standard Notes?

Yes! Self-hosting both the app and server is possible and relatively simple. There are two components to the self-hosted infrastructure:

Standard Notes Backend Infrastructure

The first is the backend infrastructure. The backend is zero-knowledge, which means it does not understand the contents of what it is storing. Any user content received by the server is always encrypted by the client beforehand.

The server is responsible for authentication and syncing. When you self-host your own server, the end result will be an endpoint that you expose via HTTPS. You enter this endpoint in the Standard Notes client applications in the Custom sync server field (found under Advanced options when signing in or registering). Get started with self-hosting your own Standard Notes server:

  • Deploying a private Standard Notes server using Docker

Self-hosting Standard Notes client applications

Because the client applications (desktop, web, and mobile) allow the option of specifying which server to connect to, self-hosting the client applications is not as common as self-hosting the server. If you were to go down this route, the paths you might take are:

  • Self hosting the Standard Notes web app (app.standardnotes.com) on your own server so that you do not rely on our own instance for portable usage.
  • Compiling the desktop and mobile apps from source to achieve maximum configurability or peace of mind.

To get started with self-hosting our client applications, visit our app code repository.

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 and desktop app with your self-hosted server.

Get Started using Docker

💡 Informative note:

The steps based on this documentation may differ from the network you have configured. If you follow all the steps to the letter, they may not match your network configuration and render the Standard Notes Docker container unusable. Always adapt the documentation to match your network and configuration.

In order to document the process, I have created a folder with different pages to document the process correctly.

pages readme
👉 Using our docker-compose configuration with MariaDB. installation
👉 Install nginx and provide https to your instance. nginx
👉 Configuring the MariaDB database and file uploads. configuration
👉 Troubleshooting page. troubleshooting
💡 Informative note:

  Our configuration also provides a Redis cache node. I will provide help with that as well.

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.

If you are new to Docker, please see the official Docker documentation on how to get started. Ensure you install Docker-Compose following the documentation. Your Linux distribution may not have the most up to date docker-compose and will fail to load.

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.

Web application

 If you would like to self-host the actual Standard Notes web application, visit the repository for the web app on GitHub:

Repository for the web app on GitHub

Help me and contribution

🙌  If you have any problems with the operation of Standard Notes, please, open a issue here:

Link

🙌  If you want to contribute to improve the installation configuration with MariaDB, open a issue here:

Link

Credits

🚀  This repository is made with all my love and affection.

GitHub

🎉 ¡Ready!

server

 

💡 Informative note:

These files/texts are provided "AS IS", without warranties of any kind, express or implied, including, but not limited to, warranties of merchantability, fitness for a particular purpose and non-infringement. In no event shall the authors or copyright holders be liable for any claims, damages or other liability arising out of or relating to the files or the use thereof.

Any and all trademarks are the property of their respective owners.