To set up a SafeLine instance, follow our getting started guide.
¶ Dependencies
Minimum configuration requirements
| Dependency | Value |
|---|---|
| Operating system | Linux |
| Instruction architecture | x86_64, arm64 |
| Software dependency | Docker version 20.10.14 or above |
| Software dependency | Docker Compose version 2.0.0 or above |
| Minimum environment | 1 core CPU / 1 GB memory / 5 GB disk |
You can execute the following commands to confirm the server configuration:
uname -m # view Instruction architecture
docker version # view Docker version
docker compose version # view Docker Compose version
cat /proc/cpuinfo| grep "processor" # view CPU info
free -h # view memory info
df -h # view disk info
lscpu | grep ssse3 # Check CPU ssse3 instruction
¶ Deploy
¶ Automatic Deploy
Recommended
Use the following command to start the automated installation of SafeLine. (This process requires root privileges)
bash -c "$(curl -fsSLk https://waf.chaitin.com/release/latest/manager.sh)" -- --en
After the command is executed, it means the installation is successfully. Please go to Use Web UI directly.
¶ Mannually Deploy
¶ Install Docker
Install the latest version of Docker.
If you already have Docker installed, please skip this step.
curl -sSL "https://get.docker.com/" | bash
¶ Create SafeLine Directory
Create a directory for SafeLine to use, SafeLine will write its configuration and data to this directory. (You need to have at least 5GB of disk space)
mkdir -p "/data/safeline"
¶ Docker Compose Script
Download the latest docker compose script by using the following command.
cd "/data/safeline"
wget "https://waf.chaitin.com/release/latest/compose.yaml"
¶ Write Environment variables
cd "/data/safeline"
touch ".env"
Write the following content in the ".env" file
SAFELINE_DIR=/data/safeline
IMAGE_TAG=latest
MGT_PORT=9443
POSTGRES_PASSWORD={postgres-password}
SUBNET_PREFIX=172.22.222
IMAGE_PREFIX=chaitin
ARCH_SUFFIX=
RELEASE=
REGION=-g
If deploying to an ARM server, change ARCH_SUFFIX to -arm
ARCH_SUFFIX=-arm
If you want to install the LTS version
RELEASE=-lts
- SAFELINE_DIR: 123
- IMAGE_TAG: SafeLine version to be used
- MGT_PORT: Web console port to be used
- POSTGRES_PASSWORD: Postgres db initialization password
- SUBNET_PREFIX: SafeLine internal network communication address prefix
- IMAGE_PREFIX: Mirror repository prefix
- ARCH_SUFFIX: Set to
-armfor ARM servers. - RELEASE: Set to
-ltsfor use LTS version.
¶ Launch SafeLine
Everything is ready to start the SafeLine service.
This process may take several minutes, so don't worry.
docker compose up -d
¶ Use Web UI
Open the web console page https://<safeline-ip>:9443/ in the browser, then you will see below.
¶ Get Administrator Account
docker exec safeline-mgt resetadmin
After the command is successfully executed, you will see the following content
Please must remember this content
[SafeLine] Initial username：admin
[SafeLine] Initial password：**********
[SafeLine] Done
¶ Login
Enter the password in the previous step and you will successfully logged into SafeLine.
¶ Uninstallation
If you are sure no longer want to use SafeLine, please follow the steps below to completely uninstall it.
- Enter SafeLine directory
cd <safeline-directory>
- Execute the follow command to stop SafeLine
docker compose down
- Execute the follow command to remove SafeLine data
rm -rf <safeline-directory>