What kind of servers can I connect to HCS?

Introduction

A guide to help you understand what kind of servers you can connect to HCS.

No matter what type of server you have (localhost or remote), you need the following requirements.

• Connectivity

  • SSH connectivity between HCS and the server with SSH key authentication.

• Docker Engine (24+)

Types

• Localhost: the server where HCS is installed.

• Remote Server: could be any remote linux server.

Localhost

To be able to manage the server where HCS is running on, the docker container of HCS should reach the host server through SSH.

You can use localhost as a server where all your resources are running, but it is not recommended as high server usage could prevent to use HCS.

Remote Server

You can connect any type of servers to HCS. It could be a VPS, a Raspberry PI or a laptop running Linux.

Cloudflare Tunnels

You can also set to use Cloudflare Tunnels for your servers.

Features

Disk Cleanup threshold

You can set a threshold in % for your / filesystem. If this percentage is reached, HCS tries to cleanup a lot of unnecessary files from your server.

• Unused Docker Images (docker image prune -af')

• Unused Docker Build Images (docker builder prune -af)

• Stopped Docker Containers deployed by HCS (docker container prune -f --filter "label=HCS.managed=true")

Wildcard Domain

You can set a wildcard domain (example: http://example.com) to your server, so you can easily assign generated domains to all the resources connected to this server.

Example: Your application UUID is vgsco4o.

If you have the example set, you will get the following FQDN: http://vgsco4o.example.com

If you do not have any wildcard domain set, HCS will generate a sslip.io domain, which is free & magical domain that you can use anywhere.

In this case, it will be: http://vgsco4o.127.0.0.1.sslip.io, where 127.0.0.1 is your server’s IP.

Proxy

• Traefik: Automatically configure Traefik(v2) based on your deployed resources.

• Custom/None: You will configure a proxy manually (only for advanced users).

Traefik

HCS uses Traefik proxy by default to create a reverse proxy for your resources.

Dynamic Configuration

You can always add your own configuration to the proxy settings fromHCS’s UI (/server/<server_uuid>/proxy).