Deploy code and install add-ons

The Tools tab gathers what you can do with one environment. From here you deploy your code, manage its add-ons, and open its firewall, domains and SSH keys.

Open Tools

1. Open the environment, then select Tools.
2. The cards are grouped.
   • Extensions has Add-ons, described further down this page.
   • Deploy has Deploy From Git and Deploy From an Archive. They show only if you have file access on the service.
   • Networking & Access has Firewall, Domains & Certificates and SSH Keys. See Set firewall rules for an environment, Add a custom domain and SSL and Add an SSH key for Application Hosting.

Deploy from Git

1. Select Deploy From Git.
2. Type the Repository URL. It must be a public repository on https://, for example https://git.example.com/northwind/shop.git.
3. Type a Branch if you don’t want the default one. This field is optional.
4. Choose the Layer to deploy to. It must be an application layer.
5. Set the Context. ROOT serves the application at the environment’s address. Any other name serves it under that path, such as /shop.
6. Select Deploy. You see Deploy started.

Deploy from an archive

1. Select Deploy From an Archive.
2. Type the Archive URL, a direct https:// link to your archive, such as a .zip or .war file.
3. Choose the Layer and set the Context, as for Git.
4. Select Deploy.

A deploy replaces what is deployed at that context, and the application restarts during the deploy. You can follow it in Background Actions.

See the add-ons on an environment

Add-ons are ready-made extras that you install on a layer. Examples are a free SSL certificate, scheduled backups or a cache purge. Each add-on adds its own buttons, called actions, and some add to the layer’s resource use.

1. Open the environment, then select Tools, then Add-ons.
2. The page says how many add-ons are installed and lists each layer with its add-ons.
3. Select Manage on a layer to open that layer’s page, where you install, use and remove them.

The environment must be running to install add-ons or use their actions.

Install an add-on

1. On the layer’s page, find Add-ons. Available for This Layer lists what you can add. Select Browse All to see the full list, or Install Add-on.
2. In Add an Add-on, search with Search Add-ons, then pick one. A Uses Resources badge means it adds to your resource use, which is billed as usual.
3. In the Install dialog, check the Environment and Layer, and fill in any fields the add-on asks for.
4. If the add-on has terms, tick I Accept These Terms.
5. Select Install.

You can leave the page while it installs. When it ends, you see that it was installed, with any details the add-on sends back.

Use an add-on’s actions

1. On the add-on’s card, select one of its action buttons. More actions are under its menu.
2. Some actions ask you to confirm or to fill in a short form. Select Apply to run it.
3. To read what an add-on did, select Show Logs.

The Quick Actions card on the environment’s Overview shows the same buttons, so you don’t need to open the layer each time.

Uninstall an add-on

1. On the add-on’s card, open its menu and select Uninstall.
2. Confirm. This runs the add-on’s own removal steps on the layer.

Add-on badges

• Installed means it’s on this layer.
• Managed by Stack Harbor means we look after it. You can’t change or remove it.
• Permanent means it can’t be uninstalled.
• View Only means you can see it but not change it. Contact support if it needs a change.

If something goes wrong

• Only https:// URLs are accepted. Use an https:// link.
• Remove the user name and password from the URL. Only public links are accepted. Private repositories aren’t supported here.
• That URL’s host name does not resolve. Check the address for a typo.
• Git deploys for Java need a build step. Upload a .war with Deploy From an Archive instead.
• This environment has no application layer to deploy to. Add an Application Node layer first.
• You need file access on this service to deploy. Ask the account owner.
• Another add-on operation is running on this layer. Wait for it to finish.
• Start the environment first.
• The add-on took too long to answer. It may still finish; check again shortly. Open Show Logs to see where it stands.
• This add-on needs an option we can’t show here yet. Our team can run it for you. Select Contact Support.
• If you can’t install or use add-ons, the page names the permission to ask the account owner for, such as Install & Remove Add-ons or Use Add-on Actions.