Pre-Installation Checklist
This page provides a checklist to be followed before installing the self-hosted Appcircle.
Please ensure all the checks are completed for a smooth installation process.
Server Requirementsβ
The table below lists the requirements of the Appcircle server and the Appcircle DMZ server. Use the recommended values for enterprise installations and production environments.
| Requirement | Minimum | Recommended |
|---|---|---|
| CPU | 8 cores | 16 or 32 cores |
| CPU architecture | x86_64 (AMD or Intel 64-bit) | x86_64 |
| RAM | 16 GB | 64 GB |
| Disk | 500 GB | 1 TB SSD |
| Swap | Half of the RAM size | Equal to the RAM size |
| Operating system, Docker | Ubuntu 20.04, Debian 11, CentOS 8 or RHEL 8, or later | Same as minimum |
| Operating system, Podman | CentOS Stream 8 or RHEL 8, or later | Same as minimum |
| DMZ server CPU | 4 cores | 32 cores |
| DMZ server RAM | 8 GB | 64 GB |
| DMZ server disk | 20 GB | 50 GB SSD |
The Appcircle DMZ server uses the same CPU architecture, operating system, and container engine as the Appcircle server.
Server Checklistβ
Check the Operating Systemβ
- The operating system and its version are listed in the server requirements.
cat /etc/os-release
Check the CPU Coresβ
- The CPU core count meets the server requirements.
nproc --all
Check the CPU Architectureβ
- The CPU architecture must be x86_64.
uname -i
If the command above doesn't work, you can try the command below.
arch
Check the RAM Sizeβ
- The RAM size meets the server requirements.
free -h
Check the Disk Sizeβ
- The disk size meets the server requirements.
df -h
Keep in mind that SSDs are a better and recommended choice for faster disk operations.
Check the Swap Sizeβ
- The swap size meets the server requirements.
free -h
If you don't have any swap space or it's insufficient, you can find the configuration details here.
Check the Swappinessβ
- The swappiness configuration should be 10.
sudo cat /proc/sys/vm/swappiness
If the output is not 10, you can find the configuration details here.
Configure the DNS Settingsβ
- Create a subdomain under your company's primary domain name.
For example, if your company is "Spacetech" with the domain spacetech.com, you can create a subdomain like appcircle.spacetech.com or appcircle-test.spacetech.com to assign to the Appcircle server.
It will be the main domain for the self-hosted Appcircle server.
The main domain (appcircle.spacetech.com, for instance.) should have the subdomains below, which should resolve to the IP address of the Appcircle server.
-
Create these domain name entries on your DNS.
-
api.appcircle.spacetech.com -
auth.appcircle.spacetech.com -
dist.appcircle.spacetech.com -
hook.appcircle.spacetech.com -
my.appcircle.spacetech.com -
resource.appcircle.spacetech.com -
store.appcircle.spacetech.com -
monitor.appcircle.spacetech.com -
redis.appcircle.spacetech.com -
mcp.appcircle.spacetech.com
-
-
All of these domain names should resolve to the same server IP address, which is the Appcircle server.
You can see details in the DNS Settings section.
Obtain an SSL Certificateβ
- You should create only one SSL certificate that covers all the domain names which you have seen in the Configure DNS section above.
- The SSL certificate should be in PEM format.
- The SSL certificate private key must not have a passphrase.
- Obtain the root CA certificate of your company.
- Obtain the intermediate CA certificate of your company if it exists.
Obtain the SMTP Settingsβ
- Obtain the IP address or host name of the SMTP server.
- Obtain the port number of the SMTP server.
- Determine if the SMTP server is using
SSL. - Determine if the SMTP server is using
STARTTLS.- β οΈ
SSLandSTARTTLSare not the same thing.
- β οΈ
- Determine if the SMTP server requires SSL certificate verification.
- β¨ Appcircle server version
3.23.1or later supports disabling the certificate verification if you have problems with the SMTP server certificate and need a workaround for certificate errors while troubleshooting. - β οΈ It's not recommended to disable the SSL certificate verification in production environments.
- β¨ Appcircle server version
- If the SMTP server requires authentication:
- Create a user for Appcircle on the SMTP server.
- Obtain the password of the Appcircle user on the SMTP server.
- Contact the system admin to get required permissions to send email with the Appcircle user via the SMTP server.
- Create a firewall rule (or permission) from the Appcircle server to the SMTP server.
Configure the Git Serverβ
- Import Appcircle Android and/or iOS sample repositories on your local git server.
- Create an Appcircle user on the git server (GitLab, Azure DevOps, Bitbucket).
- Give the required permissions to the Appcircle user to clone and edit the repositories.
- If you are using GitLab, Azure DevOps, Bitbucket:
- Create an Appcircle user. Give it permissions for the repositories.
- Create a personal access token that has sufficient permissions.
- For details like token permissions, check the connect your repository section.
- If you are using any other git server:
- Create a public-private SSH key pair.
- Configure your Appcircle git user's public SSH keys and upload the public SSH key you created.
- For details, you can check the connect via SSH section.
- Create a firewall rule (or permission) between the Appcircle server and the git server in both directions.
Network Access for Installationβ
According to the selected Linux distribution and installation method, you need to configure firewall rules (or permissions) for the Appcircle server. All required domains that are used for installation are detailed in the network access section.
- Review the network access section and be sure that the listed domains are reachable from the Appcircle server.
Runner Checklistβ
Network Access for Installationβ
The Appcircle runner should be able to access the Appcircle server.
- Create a firewall rule (or permission) from the Appcircle runner to the Appcircle server.
Port depends on the configured external.scheme in the global.yaml.
- Port
443must be allowed if the Appcircle server is configured as HTTPS. - Ports
80and6379Β must be allowed if the Appcircle server is configured as HTTP.
The Appcircle runner should be able to access to the git provider
- Create a firewall rule (or permission) from the Appcircle runner to the git server.
Port depends on the selected connection method. Default values can be:
- HTTP(s):
80or443 - SSH:
22
If your git server has a custom port for git servcies, then you should use that port.
- Review the network access section and be sure that the listed domains are reachable from the Appcircle runner.