Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 122 additions & 0 deletions docs/installation/setup_linux_standalone/1panel_install.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# 1Panel Installation

## 1. Install 1Panel
!!! tip ""
- For installation, deployment, and basic features of 1Panel, please refer to the [1Panel Official Documentation](https://1panel.cn/docs/installation/online_installation/).
- After completing the 1Panel installation, open your browser and navigate to the 1Panel URL as prompted, as shown below.

![1Panel Page](../../img/1panel_install_01.png)

## 2. Install Database
!!! tip ""
- Before installing JumpServer, you need to install the required software MySQL/PostgreSQL and Redis on 1Panel.

### 2.1 Install MySQL Database
!!! tip ""
- Click the "App Store" module on the left side of the page, select MySQL, click "Install," and choose version 5.7.xx.

![Install MySQL Database_01](../../img/1panel_install_02.png)

![Install MySQL Database_02](../../img/1panel_install_03.png)

!!! tip ""
- Detailed parameter explanation:

!!! tip ""

| Parameter | Description |
| ------- | ---------------------------- |
| Name | Created MySQL application name. |
| Version | Created MySQL application version. |
| root User Password | root user password for installation of the MySQL application. |
| Port | Service port of the MySQL application. |
| Container Name | Container name of the MySQL application. |
| External Port Access | Allow external port access and open firewall ports. |
| CPU Limit | Number of CPU cores the MySQL application can use. |
| Memory Limit | Amount of memory the MySQL application can use. |
| Edit Compose File | Supports customized compose files to start the container. |

### 2.2 Install Redis Database
!!! tip ""
- Click the "App Store" module on the left side of the page, select Redis, and click "Install."

![Install Redis Database](../../img/1panel_install_04.png)

!!! tip ""
- Detailed parameter explanation:

!!! tip ""

| Parameter | Description |
| ------- | ---------------------------- |
| Name | Created Redis application name. |
| Version | Created Redis application version. |
| Password | root user password for installation of the Redis application. |
| Port | Service port of the Redis application. |
| Container Name | Container name of the Redis application. |
| External Port Access | Allow external port access and open firewall ports. |
| CPU Limit | Number of CPU cores the Redis application can use. |
| Memory Limit | Amount of memory the Redis application can use. |
| Edit Compose File | Supports customized compose files to start the container. |

### 2.3 Database Status Check
!!! tip ""
- Click the "App Store" module on the left side of the page, switch to the "Installed" app list, and check that the status of the MySQL and Redis services has changed to "Running."

![Database Status Check](../../img/1panel_install_05.png)

## 3. Install JumpServer

!!! tip ""
- Click the "App Store" module on the left side of the page, select JumpServer, and click "Install."

![Install JumpServer](../../img/1panel_install_06.png)

!!! tip ""
- Select the latest JumpServer version on the application details page, and perform relevant parameter settings.

![Install JumpServer](../../img/1panel_install_07.png)

!!! tip ""
- Detailed parameter explanation:

!!! tip ""

| Parameter | Description |
| ------- | ---------------------------- |
| Name | Created JumpServer application name. |
| Version | Created JumpServer application version. |
| Secret Key | JumpServer's SECRET_KEY. Keep the default. Save this key if you plan to migrate the environment. |
| Bootstrap Token | JumpServer's BOOTSTRAP_TOKEN. Keep the default. Save this token if you plan to migrate the environment. |
| Debug Mode | Supports enabling debug mode. |
| Log Level | Log level, supports configuring DEBUG, INFO, WARNING, ERROR, CRITICAL. |
| Database Service | The MySQL database application used by JumpServer. Supports selecting from the installed MySQL apps in the dropdown. 1Panel will automatically configure JumpServer to use this database. |
| Database Name | The database name used by JumpServer. 1Panel will automatically create this database in the selected database server. |
| Database User Password | The database user password used by JumpServer. 1Panel will automatically configure this password for the user created in the previous step. |
| Cache Service | The Redis database application used by JumpServer. Supports selecting from the installed Redis apps in the dropdown. 1Panel will automatically configure JumpServer to use this database. |
| Cache Service Password | Password for the Redis database used by JumpServer. 1Panel will automatically configure this password. |
| Web Port | Access JumpServer frontend via HTTP protocol. |
| SSH Port | Connect to JumpServer via SSH client using terminal tools such as Xshell, PuTTY, or MobaXterm. |
| Magnus MySQL Port | Connect to MySQL database assets via DB client. |
| Magnus MariaDB Port | Connect to MariaDB database assets via DB client. |
| DOMAINS | Define trusted access IPs. Modify based on your situation. If using a public IP, please update this to the corresponding public IP. |
| Container Name | JumpServer app container name. |
| External Port Access | Allow external port access and open firewall ports. |
| CPU Limit | Number of CPU cores the JumpServer application can use. |
| Memory Limit | Amount of memory the JumpServer application can use. |
| Edit Compose File | Supports customized compose files to start the container. |

!!! tip ""
- Click the "App Store" module on the left side of the page, switch to the "Installed" app list, and check that the status of the JumpServer service has changed to "Running."

![Check JumpServer](../../img/1panel_install_08.png)

## 4. Access JumpServer
!!! info "After successful installation, log in to JumpServer through a browser."
```sh
Address: http://<1Panel_Server_IP>:<JumpServer_Service_Port>
Username: admin
Password: admin
```

![Access JumpServer](../../img/1panel_install_09.png)
228 changes: 228 additions & 0 deletions docs/installation/setup_linux_standalone/offline_install.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
# Offline Installation

!!! info "Commands required for installation, refer to [Requirements](./requirements.md) for manual installation."

| OS/Arch | Architecture | Linux Kernel | Offline Name |
| :------------ | :----------- | :----------- | :----------------------------------------------- |
| linux/amd64 | x86_64 | >= 4.0 | jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz |

## 1. Installation and Deployment

!!! warning ""
- Offline installation for the Community Edition currently only supports linux/amd64 architecture. For other architectures, please: [Apply for Enterprise Edition Trial](https://www.jumpserver.com/#features-JumpServer%20Enterprise%20Edition)

=== "linux/amd64"
!!! tip ""
Download the [latest linux/amd64 offline package](https://www.jumpserver.com/#features-JumpServer%20Enterprise%20Edition){:target="_blank"} from the FIT2CLOUD community, and upload it to the /opt directory of the deployment server.
> Please contact us for English version offline package download.

!!! tip ""
```sh
cd /opt
tar -xf jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz
cd jumpserver-ce-{{ jumpserver.tag }}-x86_64
```
```sh
# Modify the configuration file template as needed. If you are unsure of the usage, you can skip this step.
cat config-example.txt
```
```vim
# JumpServer configuration file example.
#
# If you don't understand the purpose, you can skip modifying this configuration file, the system will automatically fill in
# Complete parameter documentation https://docs.jumpserver.org/zh/v3/guide/env/

################################# Image Configuration #################################
#
# The connection to docker.io in China will timeout or the download speed will be slow, enable this option to use Huawei Cloud image acceleration
# Replace the old version DOCKER_IMAGE_PREFIX
#
# DOCKER_IMAGE_MIRROR=1

# Image pull policy Always, IfNotPresent
# Always means that the latest image will be pulled every time, IfNotPresent means that the image will be pulled only if it does not exist locally
#
# IMAGE_PULL_POLICY=Always

############################## Installation Configuration #############################
#
# JumpServer database persistence directory, by default, recordings, task logs are in this directory
# Please modify according to the actual situation, the database file (.sql) and configuration file backed up during the upgrade will also be saved to this directory
#
VOLUME_DIR=/data/jumpserver

# Encryption key, please ensure that SECRET_KEY is consistent with the old environment when migrating, do not use special strings
# (*) Warning: Keep this value secret.
# (*) Do not disclose SECRET_KEY to anyone
#
SECRET_KEY=

# The token used by the component to register with core, please keep BOOTSTRAP_TOKEN consistent with the old environment when migrating,
# Do not use special strings
# (*) Warning: Keep this value secret.
# (*) Do not disclose BOOTSTRAP_TOKEN to anyone
#
BOOTSTRAP_TOKEN=

# Log level INFO, WARN, ERROR
#
LOG_LEVEL=ERROR

# The network segment used by the JumpServer container, please do not conflict with the existing network, modify according to the actual situation
#
DOCKER_SUBNET=192.168.250.0/24

# ipv6 nat, no need to enable under normal circumstances
# If the host does not support ipv6, enabling this option will prevent the real client ip address from being obtained
#
USE_IPV6=0
DOCKER_SUBNET_IPV6=fc00:1010:1111:200::/64

################################# DB Configuration ####################################
# For external databases, you need to enter the correct database information, the system will automatically handle the built-in database
# (*) The password part must not contain single quotes and double quotes
#
DB_ENGINE=postgresql
DB_HOST=postgresql
DB_PORT=5432
DB_USER=postgres
DB_PASSWORD=
DB_NAME=jumpserver

# If external MySQL needs to enable TLS/SSL connection, refer to https://docs.jumpserver.org/zh/v3/installation/security_setup/mysql_ssl/
#
# DB_USE_SSL=true

################################# Redis Configuration #################################
# For external Redis, please enter the correct Redis information, the system will automatically handle the built-in Redis
# (*) The password part must not contain single quotes and double quotes
#
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_PASSWORD=

# If you are using external Redis Sentinel, please manually fill in the following content
#
# REDIS_SENTINEL_HOSTS=mymaster/192.168.100.1:26379,192.168.100.1:26380,192.168.100.1:26381
# REDIS_SENTINEL_PASSWORD=your_sentinel_password
# REDIS_PASSWORD=your_redis_password
# REDIS_SENTINEL_SOCKET_TIMEOUT=5

# If external Redis needs to enable TLS/SSL connection, refer to https://docs.jumpserver.org/zh/v3/installation/security_setup/redis_ssl/
#
# REDIS_USE_SSL=true

################################# Access Configuration ################################
# The service port provided to the outside, if it conflicts with the existing service, please modify it yourself
#
HTTP_PORT=80

################################# HTTPS Configuration #################################
# Refer to https://docs.jumpserver.org/zh/v3/installation/proxy/ for configuration
#
# HTTPS_PORT=443
# SERVER_NAME=your_domain_name
# SSL_CERTIFICATE=your_cert
# SSL_CERTIFICATE_KEY=your_cert_key
#

# Nginx file upload and download size limit
#
CLIENT_MAX_BODY_SIZE=4096m

################################# Component Configuration #############################
# Component registration use, by default, register to the core container, the cluster environment needs to be modified to the cluster vip address
#
CORE_HOST=http://core:8080
PERIOD_TASK_ENABLED=true

# Core Session definition,
# SESSION_COOKIE_AGE indicates how many seconds the session expires after idling,
# SESSION_EXPIRE_AT_BROWSER_CLOSE=true means that the session expires as soon as the browser is closed
#
# SESSION_COOKIE_AGE=86400
SESSION_EXPIRE_AT_BROWSER_CLOSE=false

# Trusted DOMAINS definition,
# Define the trusted access IP, please modify according to the actual situation, if it is a public IP, please change to the corresponding public IP,
# DOMAINS="demo.jumpserver.org:443"
# DOMAINS="172.17.200.191:80"
# DOMAINS="demo.jumpserver.org:443,172.17.200.191:80"
DOMAINS=

# Configure the components that do not need to be started, by default all components will be started, if you do not need a certain component, you can set {component name}_ENABLED to 0 to turn it off
# CORE_ENABLED=0
# CELERY_ENABLED=0
# KOKO_ENABLED=0
# LION_ENABLED=0
# CHEN_ENABLED=0
# WEB_ENABLED=0

# Lion enables font smoothing to optimize the experience
#
JUMPSERVER_ENABLE_FONT_SMOOTHING=true

################################# XPack Configuration #################################
# XPack package, invalid setting in open source version
#
SSH_PORT=2222
RDP_PORT=3389
XRDP_PORT=3390
MAGNUS_MYSQL_PORT=33061
MAGNUS_MARIADB_PORT=33062
MAGNUS_REDIS_PORT=63790
MAGNUS_POSTGRESQL_PORT=54320
MAGNUS_SQLSERVER_PORT=14330
MAGNUS_ORACLE_PORTS=30000-30030

################################## Other Configuration ################################
# The terminal uses the host HOSTNAME as the identifier, automatically generated during the first installation
#
SERVER_HOSTNAME=${HOSTNAME}

# Use built-in SLB, if the client IP address obtained by the Web page is not correct, please set USE_LB to 0
# When USE_LB is set to 1, use the configuration proxy_set_header X-Forwarded-For $remote_addr
# When USE_LB is set to 0, use the configuration proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
USE_LB=1

# The current running version number of JumpServer, automatically generated after installation and upgrade
#
TZ=Asia/Shanghai
CURRENT_VERSION=
```
```sh
# Install
./jmsctl.sh install

# Start
./jmsctl.sh start
```

!!! info "After installation, the JumpServer configuration file path is: /opt/jumpserver/config/config.txt"

!!! tip ""
```sh
cd jumpserver-ce-{{ jumpserver.tag }}-x86_64

# Start
./jmsctl.sh start

# Stop
./jmsctl.sh down

# Uninstall
./jmsctl.sh uninstall

# Help
./jmsctl.sh -h
```

## 2. Environment Access
!!! info "After successful installation, log in to JumpServer through a browser."
```sh
Address: http://<JumpServer_Server_IP>:<Service_Port>
Username: admin
Password: ChangeMe
```

![Login Page](../../img/online_install_01.png)
26 changes: 26 additions & 0 deletions docs/installation/setup_linux_standalone/offline_upgrade.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Offline Upgrade

!!! warning "If you want to upgrade JumpServer from V3 to V4, you must first upgrade to the latest version of V3; otherwise, the upgrade will fail!"

| OS/Arch | Architecture | Linux Kernel | Offline Name |
| :------------ | :----------- | :----------- | :----------------------------------------------- |
| linux/amd64 | x86_64 | >= 4.0 | jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz |

## 1. Upgrade Deployment

=== "linux/amd64"
!!! tip ""
Download the [latest linux/amd64 offline package](https://www.jumpserver.com/#features-JumpServer%20Enterprise%20Edition){:target="_blank"} from the FIT2CLOUD community, and upload it to the /opt directory of the deployment server.

> Please contact us for English version offline package download.

!!! tip ""
```sh
cd /opt
tar -xf jumpserver-ce-{{ jumpserver.tag }}-x86_64.tar.gz
cd jumpserver-ce-{{ jumpserver.tag }}-x86_64
```
```sh
./jmsctl.sh upgrade
./jmsctl.sh start
```
Loading