mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-11 23:02:54 +01:00
Chore/cleanup before open source (#55)
* Chore: Cleanup * Updated some urls to images and removed parts of documentation that is no longer valid * Removal of some documentation that is no longer valid * Removed PDF Export module --------- Co-authored-by: Johan Olsson <johan@noodl.net>
This commit is contained in:
kotte
GitHub
@@ -2,36 +2,33 @@
|
||||
title: Using a self hosted backend
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# Using a self hosted backend
|
||||
|
||||
## What you will learn in this guide
|
||||
|
||||
This guide will let you create a self hosted backend with an external database. This is an alternative to using an **Noodl Hosted Cloud Services**. Some reasons why you might want to do this could be:
|
||||
This guide will let you create a self hosted backend with an external database. This is an alternative to using a built on **Noodl Cloud Service**. Some reasons why you might want to do this could be:
|
||||
|
||||
- You want to host your own database, maybe to ensure where data is stored or other privacy reasons.
|
||||
- You want to host your own backend on a cloud service such as AWS or Google Cloud Platform.
|
||||
|
||||
:::note
|
||||
**Self Hosting**<br/>Note: To be able to follow this guide you must have "Self Host" feature enabled. This is not available in the free Noodl plan. But you can request a trial [here](https://noodl.net/plans).
|
||||
:::
|
||||
- You want to host your own database, maybe to ensure where data is stored or other privacy reasons.
|
||||
- You want to host your own backend on a cloud service such as AWS or Google Cloud Platform.
|
||||
|
||||
## Overview
|
||||
|
||||
We will go through the follwing steps
|
||||
|
||||
- Set up a Database cluster on MongoDB Atlas (any MongoDB or Postgres database is supported)
|
||||
- Spin up a container with the Noodl backend docker image.
|
||||
- Connect to the self hosted backend from your Noodl project.
|
||||
- Set up a Database cluster on MongoDB Atlas (any MongoDB or Postgres database is supported)
|
||||
- Spin up a container with the Noodl backend docker image.
|
||||
- Connect to the self hosted backend from your Noodl project.
|
||||
|
||||
## The different parts of a Noodl App
|
||||
|
||||
As a background it's good to know that a Noodl App consists of three parts:
|
||||
|
||||
- **The database** All Noodl applications must be backed by a database, you can use either a MongoDB or Postgres compatible database. This is where users and other records are stored. Nodes like **Query Records** access the database via the backend web service.
|
||||
- **The database** All Noodl applications must be backed by a database, you can use either a MongoDB or Postgres compatible database. This is where users and other records are stored. Nodes like **Query Records** access the database via the backend web service.
|
||||
|
||||
- **The backend service** This is the Noodl backend service that is provided via a Docker image and an instance can be started on most cloud providers. The Noodl backend is based on and compatable with the [Parse Platform](https://parseplatform.org) which is a great choice for a backend service. A solid open source project with an active foundation supporting many of the critical functions needed.
|
||||
- **The backend service** This is the Noodl backend service that is provided via a Docker image and an instance can be started on most cloud providers. The Noodl backend is based on and compatable with the [Parse Platform](https://parseplatform.org) which is a great choice for a backend service. A solid open source project with an active foundation supporting many of the critical functions needed.
|
||||
|
||||
- **Static frontend hosting** Noodl applications are SPAs (Single Page Applications) and need a place that serves the application frontend created when you deploy your application from Noodl. You can use a **Noodl hosted** frontend, with a custom domain, together with a self hosted backend, or you can host the frontend yourself as well.
|
||||
- **Static frontend hosting** Noodl applications are SPAs (Single Page Applications) and need a place that serves the application frontend created when you deploy your application from Noodl.
|
||||
|
||||
This guide will look at setting up your own self hosted **Database** and **Backend**.
|
||||
|
||||
@@ -51,7 +48,6 @@ You can start by choosing the free plan (you can always upgrade later) and then
|
||||
|
||||
Once your database is up and running you need to get the connection details for the next step. First you need to obtain the password of the **Admin** user. You will find your database users under the **Database Access** section.
|
||||
|
||||
|
||||
<div className="ndl-image-with-background m">
|
||||
|
||||
|
||||
@@ -90,7 +86,7 @@ Now you need to copy and keep the connection URI shown below. It will look somet
|
||||
mongodb+srv://Admin:<password>@cluster0.xxxxxxx.mongodb.net/?retryWrites=true&w=majority
|
||||
```
|
||||
|
||||
You need to replace the ```<password>``` with the **Admin** password you generated before. Also, insert the name of your database in the url, you can pick any name, let's call it `noodldb`, your final URL should look something like this:
|
||||
You need to replace the `<password>` with the **Admin** password you generated before. Also, insert the name of your database in the url, you can pick any name, let's call it `noodldb`, your final URL should look something like this:
|
||||
|
||||
```bash
|
||||
mongodb+srv://Admin:<password>@cluster0.xxxxxxx.mongodb.net/noodldb?retryWrites=true&w=majority
|
||||
@@ -102,10 +98,9 @@ Keep this URI safe as it will have full access to your database.
|
||||
|
||||
Next up we will deploy an instance of the Noodl backend service that we will point our application to. We provide guides for setting up Noodl on Amazon Web Services or Google Cloud Platform, follow the links below and set up the container. When you are ready you can proceed to the **Connect your application to the self hosted backend** below.
|
||||
|
||||
* **Setting up a backend on AWS** Make sure you have an AWS account created and then follow [this guide](/docs/guides/deploy/setting-up-backend-on-aws).
|
||||
|
||||
* **Setting up a backend on GCP** Make sure you have account on Google Cloud Platform created and then follow [this guide](/docs/guides/deploy/setting-up-backend-on-gcp).
|
||||
- **Setting up a backend on AWS** Make sure you have an AWS account created and then follow [this guide](/docs/guides/deploy/setting-up-backend-on-aws).
|
||||
|
||||
- **Setting up a backend on GCP** Make sure you have account on Google Cloud Platform created and then follow [this guide](/docs/guides/deploy/setting-up-backend-on-gcp).
|
||||
|
||||
### Connect your application to the self hosted backend
|
||||
|
||||
@@ -135,17 +130,17 @@ Create a new cloud service. Make sure the **Self Hosted** checkbox is checked:
|
||||
|
||||
Fill out the information
|
||||
|
||||
- **Name** - Any name you want. This will be the name of the backend in the list of backends.
|
||||
- **Description** - Some descriptive text of the backend.
|
||||
- **Endpoint** - This is the url to the backend service you have created in the previous step.
|
||||
- **Application id** - This is the application id that you provided when setting up the backend service in the previous step. It's simply and identifier of your own choosing.
|
||||
- **Masterkey** - This is the master key to the backend service you created in the previous step. It is needed by the editor to access the database for the dashboard, query nodes etc. This is stored locally and encrypted. You need to keep this safe as with it you have full access to your backend and database.
|
||||
- **Name** - Any name you want. This will be the name of the backend in the list of backends.
|
||||
- **Description** - Some descriptive text of the backend.
|
||||
- **Endpoint** - This is the url to the backend service you have created in the previous step.
|
||||
- **Application id** - This is the application id that you provided when setting up the backend service in the previous step. It's simply and identifier of your own choosing.
|
||||
- **Masterkey** - This is the master key to the backend service you created in the previous step. It is needed by the editor to access the database for the dashboard, query nodes etc. This is stored locally and encrypted. You need to keep this safe as with it you have full access to your backend and database.
|
||||
|
||||
You can make some quick tests, for example opening the **Dashboard** and create a **Class** to see that it works. That's it, now you have a self hosted Noodl cloud services up and running.
|
||||
|
||||
## Migrating from a Noodl hosted cloud service
|
||||
## Migrating from a Noodl cloud service
|
||||
|
||||
If you are migrating from a Noodl hosted cloud service we can provide you with a database dump that you can use to restore your new database to, [email support to request](mailto:support@noodl.net). Once you have the backup file you need to install the MongoDB database tools, you can find instructions [here](https://www.mongodb.com/docs/database-tools/installation/installation/).
|
||||
If you are migrating from a Noodl cloud service we can provide you with a database dump that you can use to restore your new database to, [email support to request](mailto:support@noodl.net). Once you have the backup file you need to install the MongoDB database tools, you can find instructions [here](https://www.mongodb.com/docs/database-tools/installation/installation/).
|
||||
|
||||
Then you will use the following command to migrate your data:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user