jumpserver/README.md

116 lines
8.8 KiB
Markdown
Raw Normal View History

2024-06-24 10:10:49 +00:00
<div align="center">
<a name="readme-top"></a>
<a href="https://jumpserver.org/index-en.html"><img src="https://download.jumpserver.org/images/jumpserver-logo.svg" alt="JumpServer" width="300" /></a>
2024-03-28 09:49:53 +00:00
## An open-source PAM tool (Bastion Host)
2017-09-27 05:26:57 +00:00
2024-03-28 09:49:53 +00:00
[![][license-shield]][license-link]
[![][discord-shield]][discord-link]
2024-03-28 09:49:53 +00:00
[![][docker-shield]][docker-link]
[![][github-release-shield]][github-release-link]
[![][github-stars-shield]][github-stars-link]
2017-09-27 05:26:57 +00:00
2024-07-03 14:35:41 +00:00
**English** · [简体中文](./README.zh-CN.md)
2024-03-28 09:49:53 +00:00
</div>
2024-03-26 10:30:30 +00:00
<br/>
2024-06-24 10:10:49 +00:00
## What is JumpServer?
2024-03-28 09:02:52 +00:00
2024-07-04 01:47:28 +00:00
JumpServer is an open-source Privileged Access Management (PAM) tool that provides DevOps and IT teams with on-demand and secure access to SSH, RDP, Kubernetes, Database and RemoteApp endpoints through a web browser.
2024-07-03 09:46:13 +00:00
2024-07-04 01:45:45 +00:00
![JumpServer Overview](https://github.com/jumpserver/jumpserver/assets/32935519/35a371cb-8590-40ed-88ec-f351f8cf9045)
2024-07-03 09:46:13 +00:00
2024-07-18 11:41:55 +00:00
## Quickstart
2024-07-04 00:54:19 +00:00
Prepare a clean Linux Server ( 64 bit, >= 4c8g )
2024-07-18 11:41:55 +00:00
```sh
2024-07-04 00:54:19 +00:00
curl -sSL https://github.com/jumpserver/jumpserver/releases/latest/download/quick_start.sh | bash
```
2024-07-10 06:50:52 +00:00
Access JumpServer in your browser at `http://your-jumpserver-ip/`
2024-07-10 02:13:06 +00:00
- Username: `admin`
- Password: `ChangeMe`
2024-07-04 00:54:19 +00:00
[![JumpServer Quickstart](https://github.com/user-attachments/assets/0f32f52b-9935-485e-8534-336c63389612)](https://www.youtube.com/watch?v=UlGYRbKrpgY "JumpServer Quickstart")
2024-07-03 09:46:13 +00:00
## Screenshots
2024-03-26 09:40:22 +00:00
2024-06-25 06:39:19 +00:00
<table style="border-collapse: collapse; border: 1px solid black;">
<tr>
2024-07-03 06:47:12 +00:00
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/99fabe5b-0475-4a53-9116-4c370a1426c4" alt="JumpServer Console" /></td>
2024-06-25 07:30:28 +00:00
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/a424d731-1c70-4108-a7d8-5bbf387dda9a" alt="JumpServer Audits" /></td>
</tr>
<tr>
2024-06-25 07:30:28 +00:00
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/393d2c27-a2d0-4dea-882d-00ed509e00c9" alt="JumpServer Workbench" /></td>
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/3a2611cd-8902-49b8-b82b-2a6dac851f3e" alt="JumpServer Settings" /></td>
</tr>
<tr>
2024-06-25 07:30:28 +00:00
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/1e236093-31f7-4563-8eb1-e36d865f1568" alt="JumpServer SSH" /></td>
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/69373a82-f7ab-41e8-b763-bbad2ba52167" alt="JumpServer RDP" /></td>
</tr>
<tr>
2024-06-25 07:30:28 +00:00
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/5bed98c6-cbe8-4073-9597-d53c69dc3957" alt="JumpServer K8s" /></td>
<td style="padding: 5px;background-color:#fff;"><img src= "https://github.com/jumpserver/jumpserver/assets/32935519/b80ad654-548f-42bc-ba3d-c1cfdf1b46d6" alt="JumpServer DB" /></td>
</tr>
2024-06-25 06:39:19 +00:00
</table>
2024-03-29 10:46:11 +00:00
2024-06-24 10:10:49 +00:00
## Components
2024-04-01 09:09:08 +00:00
2024-06-24 10:10:49 +00:00
JumpServer consists of multiple key components, which collectively form the functional framework of JumpServer, providing users with comprehensive capabilities for operations management and security control.
2024-04-01 10:01:56 +00:00
2024-04-01 10:38:59 +00:00
| Project | Status | Description |
|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| [Lina](https://github.com/jumpserver/lina) | <a href="https://github.com/jumpserver/lina/releases"><img alt="Lina release" src="https://img.shields.io/github/release/jumpserver/lina.svg" /></a> | JumpServer Web UI |
| [Luna](https://github.com/jumpserver/luna) | <a href="https://github.com/jumpserver/luna/releases"><img alt="Luna release" src="https://img.shields.io/github/release/jumpserver/luna.svg" /></a> | JumpServer Web Terminal |
2024-04-01 10:01:56 +00:00
| [KoKo](https://github.com/jumpserver/koko) | <a href="https://github.com/jumpserver/koko/releases"><img alt="Koko release" src="https://img.shields.io/github/release/jumpserver/koko.svg" /></a> | JumpServer Character Protocol Connector |
2024-07-03 08:08:42 +00:00
| [Lion](https://github.com/jumpserver/lion) | <a href="https://github.com/jumpserver/lion/releases"><img alt="Lion release" src="https://img.shields.io/github/release/jumpserver/lion.svg" /></a> | JumpServer Graphical Protocol Connector |
| [Chen](https://github.com/jumpserver/chen) | <a href="https://github.com/jumpserver/chen/releases"><img alt="Chen release" src="https://img.shields.io/github/release/jumpserver/chen.svg" /> | JumpServer Web DB |
2024-07-03 14:55:22 +00:00
| [Razor](https://github.com/jumpserver/razor) | <img alt="Chen" src="https://img.shields.io/badge/release-private-red" /> | JumpServer EE RDP Proxy Connector |
| [Tinker](https://github.com/jumpserver/tinker) | <img alt="Tinker" src="https://img.shields.io/badge/release-private-red" /> | JumpServer EE Remote Application Connector (Windows) |
| [Panda](https://github.com/jumpserver/Panda) | <img alt="Panda" src="https://img.shields.io/badge/release-private-red" /> | JumpServer EE Remote Application Connector (Linux) |
| [Magnus](https://github.com/jumpserver/magnus) | <img alt="Magnus" src="https://img.shields.io/badge/release-private-red" /> | JumpServer EE Database Proxy Connector |
2024-07-03 06:27:21 +00:00
2024-03-26 08:53:04 +00:00
## Contributing
2024-06-24 10:10:49 +00:00
2024-04-01 10:47:29 +00:00
Welcome to submit PR to contribute. Please refer to [CONTRIBUTING.md][contributing-link] for guidelines.
2024-04-01 09:37:11 +00:00
2024-03-26 10:30:30 +00:00
## Security
2024-06-24 10:10:49 +00:00
JumpServer is a mission critical product. Please refer to the Basic Security Recommendations for installation and deployment. If you encounter any security-related issues, please contact us directly:
2024-04-01 09:37:11 +00:00
- Email: support@fit2cloud.com
2024-04-01 09:37:11 +00:00
2024-03-27 10:13:28 +00:00
## License
2024-06-24 10:10:49 +00:00
2024-04-01 09:37:11 +00:00
Copyright (c) 2014-2024 飞致云 FIT2CLOUD, All rights reserved.
Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.gnu.org/licenses/gpl-3.0.html
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an " AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
2024-04-01 09:09:08 +00:00
<!-- JumpServer official link -->
2024-07-08 06:49:56 +00:00
[docs-link]: https://jumpserver.com/docs
[discord-link]: https://discord.com/invite/W6vYXmAQG2
2024-04-01 10:47:29 +00:00
[contributing-link]: https://github.com/jumpserver/jumpserver/blob/dev/CONTRIBUTING.md
2024-04-01 09:09:08 +00:00
<!-- JumpServer Other link-->
2024-03-28 09:49:53 +00:00
[license-link]: https://www.gnu.org/licenses/gpl-3.0.html
[docker-link]: https://hub.docker.com/u/jumpserver
[github-release-link]: https://github.com/jumpserver/jumpserver/releases/latest
[github-stars-link]: https://github.com/jumpserver/jumpserver
[github-issues-link]: https://github.com/jumpserver/jumpserver/issues
2024-04-01 09:09:08 +00:00
<!-- Shield link-->
[github-release-shield]: https://img.shields.io/github/v/release/jumpserver/jumpserver
[github-stars-shield]: https://img.shields.io/github/stars/jumpserver/jumpserver?color=%231890FF&style=flat-square
2024-04-01 09:09:08 +00:00
[docker-shield]: https://img.shields.io/docker/pulls/jumpserver/jms_all.svg
[license-shield]: https://img.shields.io/github/license/jumpserver/jumpserver
[discord-shield]: https://img.shields.io/discord/1194233267294052363?style=flat&logo=discord&logoColor=%23f5f5f5&labelColor=%235462eb&color=%235462eb
2024-04-01 09:09:08 +00:00
<!-- Image link -->