Skip to content

Commit

Permalink
update deploy section
Browse files Browse the repository at this point in the history
  • Loading branch information
VisualDev-FR committed Dec 12, 2023
1 parent 5770011 commit 73f2393
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 12 deletions.
Binary file added doc/source/_static/render_07.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/_static/render_08.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/_static/render_09.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 41 additions & 12 deletions doc/source/deploy.rst
Original file line number Diff line number Diff line change
@@ -1,43 +1,72 @@
Deploying
====

This project is hosted on `Render <https://render.com/>`_, which offers a free and simple way to host a web app with a single service.

This project is hosted on `render <https://render.com/>`_, which offers a free and simple way to host a web app with a single service.


To deploy the app on render, follow this procedure :
Deploy with Render
----

To deploy the app on Render, follow this procedure:

1. Create a new Web Service

.. image:: ./_static/render_01.PNG

2. Build and deploy from a git repository
2. Build and deploy from a Git repository

.. image:: ./_static/render_02.PNG

3. Connect a repository

.. image:: ./_static/render_03.PNG

Connect to Github / Gitlab, or give the url of your public repository.
Connect to GitHub / GitLab, or provide the URL of your public repository.

4. Configure the web Service
4. Configure the Web Service

Specify the name of the project, the main branch of the project's repository, and the runtime as **Docker**
Specify the name of the project, the main branch of the project's repository, and the runtime as **Docker**.

.. image:: ./_static/render_04.PNG

5. Configure needed environement variables
5. Configure necessary environment variables

See :ref:`this section <prerequisites>` for more details about needed environement variables.
See :ref:`this section <prerequisites>` for more details about the necessary environment variables.

.. image:: ./_static/render_05.PNG

6. Configure Docker

Specify the relative path of the dockerfile, and disable the auto-deploy.
Specify the relative path of the Dockerfile and disable auto-deploy.

.. image:: ./_static/render_06.PNG

7. Deploy the web site by clicking on the dedicated button at the bottom of the page.
7. Deploy the website by clicking on the dedicated button at the bottom of the page.

Administrate with Render
----

Once the website is deployed, it will become available in your dashboard:

.. image:: ./_static/render_07.PNG

Then, you'll have access to the administration panel of Render, offering you the possibility to administate the deployed website:

.. image:: ./_static/render_08.PNG

Automate the Deployment
----

To relaunch automated deployment from an external service (such as a CI/CD pipeline), you'll need to get a Deploy hook, which is a URL to make requests to, in order to tell Render to relaunch the deployment of the website from your repository.

To get the webhook, go to Settings / Build and Deploy and copy the URL in the "Deploy hook" section:

.. image:: ./_static/render_09.PNG

.. warning::
Ensure to keep the URL secret.

Then, to relaunch the build and deployment of your app, just send a request to the given deploy hook:

.. code:: bash
curl https://deploy/hook/url

0 comments on commit 73f2393

Please sign in to comment.