Skip to content

Commit bb2d6fa

Browse files
committed
Update README.md
1 parent 4bad974 commit bb2d6fa

1 file changed

Lines changed: 15 additions & 19 deletions

File tree

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/redhat.vscode-server-connector?style=for-the-badge&label=VS%20Marketplace&logo=visual-studio-code&color=blue)](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-server-connector)
44
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/redhat.vscode-server-connector?style=for-the-badge&color=purple)](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-server-connector)
5-
[![Gitter](https://img.shields.io/gitter/room/redhat-developer/server-connector?style=for-the-badge&logo=gitter)](https://gitter.im/redhat-developer/server-connector)
6-
[![Build Status](https://img.shields.io/github/workflow/status/redhat-developer/vscode-server-connector/ServerConnectorCI?style=for-the-badge&logo=github)](https://github.com/redhat-developer/vscode-server-connector/actions)
75
[![License](https://img.shields.io/badge/license-EPLv2.0-brightgreen.png?style=for-the-badge)](https://github.com/redhat-developer/vscode-server-connector/blob/master/LICENSE)
86

9-
A Visual Studio Code extension for interacting with Red Hat Servers and Runtimes.
7+
A Visual Studio Code extension for interacting with Red Hat JBoss EAP Servers and Runtimes.
8+
9+
### Supported Servers
10+
* WildFly 33 and below (WildFly 8)
11+
* Red Hat JBoss Enterprise Application Platform (EAP) 8.0 and below (EAP 4.3)
1012

1113
## Commands and features
1214

1315
![ screencast ](https://raw.githubusercontent.com/redhat-developer/vscode-server-connector/master/screencast/vscode-server-connector.gif)
1416

15-
This extension depends on VSCode RSP UI Extension which is going to be installed automatically along with VSCode Server Connector Extension. RSP UI in conjuction with Server Connector Extension supports a number of commands for interacting with supported server adapters; these are accessible via the command menu (`Cmd+Shift+P` on macOS or `Ctrl+Shift+P` on Windows and Linux) and may be bound to keys in the normal way.
17+
This extension depends on VSCode RSP UI Extension which is going to be installed automatically along with VSCode Server Connector Extension. RSP UI in conjunction with Server Connector Extension supports several commands for interacting with supported server adapters; these are accessible via the command menu (`Cmd+Shift+P` on macOS or `Ctrl+Shift+P` on Windows and Linux) and may be bound to keys in the normal way.
1618

1719
### Available Commands
1820
This extension provides no additional commands other than those available in [rsp-ui](https://github.com/redhat-developer/vscode-rsp-ui#available-commands)
@@ -23,18 +25,12 @@ This extension depends on VSCode RSP UI Extension which is going to be installed
2325
## Server Parameters
2426
This extension provides some ADDITIONAL server parameters in addition to those available in rsp-ui. To see a list of global server parameters, please go [here](https://github.com/redhat-developer/vscode-rsp-ui#server-parameters). Below are JBoss / WildFly specific parameters.
2527

26-
* `"args.vm.override.string"` - allow to override vm arguments. Once you edited this flag, *make sure "args.override.boolean" is set to true before launching your server. Otherwise the server will attempt to auto-generate the launch arguments as it normally does.*
27-
* `"args.program.override.string"` - allow to override program arguments. Once you edited this flag, *make sure "args.override.boolean" is set to true before launching your server. Otherwise the server will attempt to auto-generate the launch arguments as it normally does.*
28-
29-
* `"jboss.server.host"` - allow to set the host you want the current Jboss/Wildfly instance to bind to (default localhost)
30-
* `"jboss.server.port"` - allow to set the port you want the current Jboss/Wildfly instance to bind to (default 8080)
31-
* `"wildfly.server.config.file"` - name of the configuration file to be used for the current Jboss/Wildfly instance. The file has to be stored in the same folder as the default standalone.xml file. (e.g "wildfly.server.config.file": "newconfigfile.xml")
32-
33-
### Supported Servers
34-
* Wildfly [8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30]
35-
* Red Hat Enterprise Application Platform (EAP) [4.3 | 5.0 | 6.0 | 6.1 | 6.2 | 6.3 | 6.4 | 7.0 | 7.1 | 7.2 | 7.3| 7.4]
36-
* Minishift / Red Hat Container Development Kit (CDK) / Red Hat CodeReady Containers (CRC) binaries
28+
* `"args.vm.override.string"` - allow to override VM arguments. Once you edit this flag, *make sure "args.override.boolean" is set to true before launching your server. Otherwise, the server will attempt to auto-generate the launch arguments as it normally does.*
29+
* `"args.program.override.string"` - allow to override program arguments. Once you edit this flag, *make sure "args.override.boolean" is set to true before launching your server. Otherwise, the server will attempt to auto-generate the launch arguments as it normally does.*
3730

31+
* `"jboss.server.host"` - allow to set the host you want the current JBoss/Wildfly instance to bind to (default localhost)
32+
* `"jboss.server.port"` - allow to set the port you want the current JBoss/Wildfly instance to bind to (default 8080)
33+
* `"wildfly.server.config.file"` - the name of the configuration file to be used for the current Jboss/Wildfly instance. The file has to be stored in the same folder as the default standalone.xml file. (e.g "wildfly.server.config.file": "newconfigfile.xml")
3834

3935
## FAQ
4036
---
@@ -72,16 +68,16 @@ Stable releases are archived under http://download.jboss.org/jbosstools/adapters
7268

7369
## Community, discussion, contribution, and support
7470

75-
**Issues:** If you have an issue/feature-request with Server Connector extension, please file it [here](https://github.com/redhat-developer/vscode-server-connector/issues).
71+
**Issues:** If you have an issue/feature-request with the Server Connector extension, please file it [here](https://github.com/redhat-developer/vscode-server-connector/issues).
7672

77-
**Contributing:** Want to become a contributor and submit your own code? Have a look at our [development guide](https://github.com/redhat-developer/vscode-server-connector/blob/master/CONTRIBUTING.md).
73+
**Contributing:** Want to become a contributor and submit your code? Have a look at our [development guide](https://github.com/redhat-developer/vscode-server-connector/blob/master/CONTRIBUTING.md).
7874

79-
**Chat:** Chat with us on [Gitter](https://gitter.im/redhat-developer/server-connector).
75+
**Chat:** Open a [Discussion on GitHub](https://github.com/redhat-developer/vscode-server-connector/discussions)
8076

8177
**UI Testing:**
8278

8379
You can perform UI testing by running the following commands:
84-
1. Download package and it's dependencies
80+
1. Download the package and its dependencies
8581
```sh
8682
npm install
8783
```

0 commit comments

Comments
 (0)