mirror of
https://github.com/penpot/penpot-docs.git
synced 2024-08-04 09:58:54 +00:00
🎉 Elestio info
This commit is contained in:
andy
Andrés Moya
parent
4cb3326d8f
commit
ed687956b7
@ -1,18 +1,74 @@
|
||||
---
|
||||
title: 1. Getting Started.
|
||||
title: 1. Getting Started
|
||||
---
|
||||
|
||||
# Getting Started #
|
||||
|
||||
This section details everything you need to know to get Penpot up and
|
||||
running in production environments. Although it can be installed in
|
||||
many ways, the recommended approach is using **docker** and
|
||||
**docker-compose**.
|
||||
running in production environments.
|
||||
|
||||
Although it can be installed in many ways,
|
||||
If you don't have experience using Docker or if you want a fully automatically managed service, we recommend using **Elestio**. Otherwise, go for **Docker**.
|
||||
|
||||
|
||||
## Install Docker ##
|
||||
## Install with Elestio ##
|
||||
|
||||
**Skip this section if you already have docker installed, up and running.**
|
||||
This section details how to get Penpot up and running using Elestio. Elestio is using the same Docker compose as recommended in “Install with Docker” therefore you can also use the [Configuration][1] options.
|
||||
|
||||
[1]: /technical-guide/getting-started/#configuration
|
||||
|
||||
|
||||
### Get an Elestio account ###
|
||||
|
||||
<p class="advice">
|
||||
Skip this section if you already have an Elestio account.
|
||||
</p>
|
||||
|
||||
<a href="https://elest.io/" target="_blank">Elestio</a> offers a fully managed service for on-premise instances of a selection of open-source software! This means you can deploy a dedicated instance of Penpot in just 3 minutes. You’ll be relieved of the need to worry about DNS configuration, SMTP, backups, SSL certificates, OS & Penpot upgrades, and much more.
|
||||
|
||||
You can choose to deploy on any one of five leading cloud providers or on-premise. To create your Elestio account <a href="https://dash.elest.io/deploy?soft=Penpot&id=121" target="_blank">click here</a>.
|
||||
|
||||
### Deploy Penpot using Elestio ###
|
||||
|
||||
Now you can Create you service in “Services”:
|
||||
1. Look for Penpot
|
||||
2. Select a Service provider
|
||||
3. Select Service Cloud Region
|
||||
4. Select Service Plan (we recommend minimum xxxx)
|
||||
5. Select Elestio Service Support
|
||||
6. Provide Service Name (this will show in the URL of your instance) & Admin email (used to create the admin account)
|
||||
7. There are Advanced Configuration options, but you can also do these later
|
||||
8. Hit “Create Service” on the bottom right
|
||||
|
||||
It will take a couple of minutes to get the instance launched. When the status turns to “Service is running” you are ready to get started.
|
||||
|
||||
By clicking on the Service you go to all the details and configuration options.
|
||||
|
||||
In Network/CNAME you can find the URL of your instance. Copy and paste this into a browser and start using Penpot.
|
||||
|
||||
### Configuration ###
|
||||
|
||||
If you want to make changes to your Penpot setup click on the “Update config” button in Software. Here you can see the “Docker compose” used to create the instance. In “ENV” top middle left you can make configuration changes that will be reflected in the Docker compose. You can find more information on the configuration options in Configuration. In the “ENV” file a “#” at the start of the line means it is text and not considered part of the configuration. This means you will need to delete it to get some of the configuration options to work. Once you made all your changes hit “Update & restart”. After a couple of minutes, your changes will be active.
|
||||
|
||||
Get in contact with us through <a href="mailto:support@penpot.app">support@penpot.app</a> if you have any questions or need help.
|
||||
|
||||
### Update Penpot ###
|
||||
|
||||
Elestio will update your instance automatically to the latest release unless you don't want this. In that case you need to “Disable auto updates” in Software auto updates.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Install with Docker ##
|
||||
|
||||
This section details everything you need to know to get Penpot up and running in production environments with Docker. Although it can be installed in many ways, the recommended approach is using **docker** and **docker-compose**.
|
||||
|
||||
### Install Docker ###
|
||||
<p class="advice">
|
||||
Skip this section if you already have docker installed, up and running.
|
||||
</p>
|
||||
|
||||
Probably the best approach to install docker is following the official docker
|
||||
installation guide: https://docs.docker.com/engine/install/
|
||||
@ -34,7 +90,7 @@ sudo usermod -aG docker $USER
|
||||
**NOTE**: probably you will need to re-login again to make this change take effect.
|
||||
|
||||
|
||||
## Start Penpot ##
|
||||
### Start Penpot ###
|
||||
|
||||
As first step you will need to obtain the `docker-compose.yaml`
|
||||
file. You can create it from scratch or start with the [default
|
||||
@ -59,7 +115,7 @@ docker compose -p penpot -f docker-compose.yaml up -d
|
||||
This will start listening on http://localhost:9001
|
||||
|
||||
|
||||
## Configuration ##
|
||||
### Configuration ###
|
||||
|
||||
If you started the application without configuring SMTP, you probably
|
||||
need to create a user in order be able login into the application. You
|
||||
@ -78,7 +134,7 @@ For more advanced setups, look a the [Configuration][3] section.
|
||||
[3]: /technical-guide/configuration/
|
||||
|
||||
|
||||
## Update Penpot ##
|
||||
### Update Penpot ###
|
||||
|
||||
To get the latest version of Penpot in your local installation, you just
|
||||
need to execute:
|
||||
@ -89,4 +145,3 @@ docker-compose -f docker-compose.yaml pull
|
||||
|
||||
This will fetch the latest images. When you do docker-compose up
|
||||
again, the containers will be recreated with the latest version.
|
||||
|
||||
|
||||
@ -11,19 +11,26 @@ eleventyNavigation:
|
||||
|
||||
# Overview
|
||||
|
||||
This documentation intends to explain how to get penpot application
|
||||
and run it locally, to test it or make changes to it.
|
||||
This documentation intends to explain how to get Penpot application and run it locally, test it, or make changes to it.
|
||||
|
||||
The official installation guide is described in the [Getting
|
||||
Started][1] section; and complemented with the [Configuration][2]
|
||||
section for more advanced setups.
|
||||
There are two main options for creating a local on-premise instance:
|
||||
|
||||
1. Using the platform of our partner <a href="https://elest.io/" target="_blank">Elestio</a>.
|
||||
2. Doing the installation yourself with Docker.
|
||||
|
||||
<p class="advice">
|
||||
If you don't have experience using Docker or if you want a fully automatically managed service, we recommend using Elestio. Otherwise, go for Docker.
|
||||
</p>
|
||||
|
||||
* In the [Install with Elestio][1] section, you can find details on how to open an Elestio account and create your Penpot instance.
|
||||
|
||||
* In the [Install with Docker][2] section, you can find the official Docker installation guide.
|
||||
|
||||
* In the [Configuration][3] section, you can find more advanced setup options.
|
||||
|
||||
* If you are a developer and want to get into the code, we recommend the [Developer Guide][4] that explains how to properly setup a development environment and many other dev-oriented documentation.
|
||||
|
||||
[1]: /technical-guide/getting-started/
|
||||
[2]: /technical-guide/configuration/
|
||||
|
||||
|
||||
If you are a developer and want to get into the code, we recommend the
|
||||
[Developer Guide][3] that explains how to properly setup a development
|
||||
environment and many other dev-oriented documentation.
|
||||
|
||||
[3]: /technical-guide/developer/
|
||||
[3]: /technical-guide/configuration/
|
||||
[4]: /technical-guide/developer/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user