Deploying Yacht through the Linode Marketplace

Traducciones al Español
Estamos traduciendo nuestros guías y tutoriales al Español. Es posible que usted esté viendo una traducción generada automáticamente. Estamos trabajando con traductores profesionales para verificar las traducciones de nuestro sitio web. Este proyecto es un trabajo en curso.

Yacht is a web interface for managing Docker containers, with an emphasis on templating to provide easy deployments. The ultimate goal of Yacht is to make Docker easy for anyone to use and manage with templates, template variables, and an intuitive UI.

Caution
Keep in mind, Yacht is still in alpha and is not recommended for production use.

Deploying the Yacht Marketplace App

The Linode Marketplace allows you to easily deploy software on a Linode using the Linode Cloud Manager.

  1. Log in to the Cloud Manager and select the Marketplace link from the left navigation menu. This displays the Linode Compute Create page with the Marketplace tab pre-selected.

  2. Under the Select App section, select the app you would like to deploy.

  3. Fill out all required Options for the selected app as well as any desired Advanced Options (which are optional). See the Configuration Options section for details.

  4. Complete the rest of the form as discussed within the Getting Started > Create a Linode.

  5. Click the Create Linode button. Once the Linode has provisioned and has fully powered on, wait for the software installation to complete. If the Linode is powered off or restarted before this time, the software installation will likely fail. To determine if the installation has completed, open the Linode’s Lish console and wait for the system login prompt to appear.

  6. Follow the instructions within the Getting Started After Deployment section.

Software installation should complete within 2-5 minutes after the Linode has finished provisioning.

Configuration Options

Yacht Options

You can configure your Yacht App by providing values for the following fields:

FieldDescription
Yacht EmailThe email address for your Yacht login. The default is [email protected]. Required.
Yacht PasswordThe password for your Yacht login. Required.
Yacht Compose SupportSupport for using Yacht with Docker Compose.
Yacht ThemeYacht theme options: Default, RED, and OMV.

General Options

For advice on filling out the remaining options on the Create a Linode form, see Getting Started > Create a Linode. That said, some options may be limited or recommended based on this Marketplace App:

  • Supported distributions: Debian 10
  • Recommended minimum plan: All plan types and sizes can be used.

Getting Started after Deployment

Access your Yacht App

  1. After Yacht has finished installing, you can access your Yacht instance by visiting your Linode’s IP address at port 8000 (for example, http://192.0.2.0:8000) in a web browser.

    Caution
    By default Yacht is not configured to use SSL, meaning that your login credentials will be sent over plain text. See Additional Steps for SSL for guidance on how to encrypt your connection.
  2. Enter your Yacht email address and password:

    Yacht Login

    You should see the Yacht administration panel:

    Yacht Dashboard

Yacht provides elegant theme customization, templating, easy management of Docker resources (volumes, images, network), applications and projects. Click the page icon on the bottom-left corner to view a live demo and official Yacht documentation.

Yacht Demo

Additional Steps for SSL

Since Yacht is not configured for SSL, some additional steps are required to encrypt your connection. The following example uses self-signed SSL certificates, but this can also work with a commercially signed or Let’s Encrypt certificates if the server is configured with a FQDN.

  1. Login to the Linode’s IP over ssh. Replace 192.0.2.0 with your Linode’s IP address.

     ssh [email protected]
    
  2. Create two local directories for SSL and the modified nginx.conf.

     mkdir -p local/nginx
     mkdir local/ssl
    
  3. Create the self-signed certificate and key.

     openssl req -new -newkey rsa:4096 -x509 -sha256 -days 365 -nodes -out yacht.crt -keyout yacht.key
    

    You should see output similar to the following:

    Generating a RSA private key
    ...............................................................................................................................................+
    ......................++++
    writing new private key to 'yacht.key'
    -----
    You are about to be asked to enter information that will be incorporated
    into your certificate request.
    What you are about to enter is what is called a Distinguished Name or a DN.
    There are quite a few fields but you can leave some blank
    For some fields there will be a default value,
    If you enter '.', the field will be left blank.
    -----
    Country Name (2 letter code) [AU]:US
    State or Province Name (full name) [Some-State]:Pennsylvania
    Locality Name (eg, city) []:Philadelphia
    Organization Name (eg, company) [Internet Widgits Pty Ltd]:
    Organizational Unit Name (eg, section) []:
    Common Name (e.g. server FQDN or YOUR name) []:yacht.local
    Email Address []:[email protected]
  4. Move the newly generated certificate and key into the local/ssl directory.

     mv yacht.* local/ssl
    
  5. Dump the Yacht nginx.conf to the local/nginx directory.

     docker exec -it yacht /bin/sh -c "cat /etc/nginx/nginx.conf" > local/nginx/nginx.conf
    
  6. Open the local/nginx/nginx.conf file using vim or another text editor of your choice and locate the server block for port 8000 (around line 30).

    File: local/nginx/nginx.conf
    ...
    server {
         listen *:8000;
    ...

    Add the ssl parameter and paths for the certificate and key.

    File: local/nginx/nginx.conf
    ...
    
    server {
         listen *:8000 ssl;
         ssl_certificate /etc/nginx/ssl/yacht.crt;
         ssl_certificate_key /etc/nginx/ssl/yacht.key;
    
    ...
  7. Copy local/nginx/nginx.conf and local/ssl to the /etc/nginx/ directory in the Yacht container, and then reload Nginx.

    docker cp local/nginx/nginx.conf yacht:/etc/nginx/
    docker cp local/ssl yacht:/etc/nginx/
    
    # remove ^M characters
    docker exec -it yacht /bin/sh -c "sed -ie 's/\r//g' /etc/nginx/nginx.conf"
    
    # reload nginx
    docker exec -it yacht /bin/sh -c "nginx -s reload"
    

Your browser may give warnings because the certificate is not signed by a Certificate Authority, and require you to add a security exception, but the connection is now encrypted.

Note
Currently, Linode does not manage software and systems updates for Marketplace Apps. It is up to the user to perform routine maintenance on software deployed in this fashion.

More Information

You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.

This page was originally published on

Create a Linode account to try this guide with a $100 credit.
This credit will be applied to any valid services used during your first 60 days.

Your Feedback Is Important

Let us know if this guide made it easy to get the answer you needed.


Join the conversation.
Read other comments or post your own below. Comments must be respectful, constructive, and relevant to the topic of the guide. Do not post external links or advertisements. Before posting, consider if your comment would be better addressed by contacting our Support team or asking on our Community Site.