- Notifications
You must be signed in to change notification settings - Fork 15
Update documentation #49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 17 commits
Commits
Show all changes
18 commits Select commit Hold shift + click to select a range
b55a12a Version 2.0
lfeigen bc2daca Version 2.0
lfeigen 75e942b Version 2.1.0
lfeigen 0f7abb5 Version 2.2
lfeigen bcde0db Release 2.3.0
lfeigen d56c632 Release 2.4.0
lfeigen 6ae16e0 Merge pull request #15 from oracle/release-2.4.0
mriccell 958d3cd Release 2.4.1
lfeigen 52ec87e Merge pull request #20 from oracle/v2.4.1
lfeigen 93a23bf Release 2.4.2
lfeigen 03d7205 Merge pull request #36 from oracle/release-2.4.2
lfeigen 4e4d476 Release 2.4.4
lfeigen a349971 Merge pull request #44 from oracle/release-2.4.4
lfeigen 354b8b9 Update SECURITY.md
spavlusieva ae84375 Update CONTRIBUTING.md
spavlusieva 8d5f630 Update LICENSE.txt
spavlusieva 89c205e Update README.md
spavlusieva b612f90 Update SECURITY.md
spavlusieva File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,55 @@ | ||
| # Contributing | ||
| # Contributing to this repository | ||
| | ||
| We welcome contributions to this repository from anyone. | ||
| We welcome your contributions! There are multiple ways to contribute. | ||
| | ||
| If you want to submit a pull request to fix a bug or enhance an existing | ||
| feature, please first open an issue and link to that issue when you | ||
| submit your pull request. | ||
| ## Opening issues | ||
| | ||
| If you have any questions about a possible submission, feel free to open | ||
| an issue too. | ||
| For bugs or enhancement requests, please file a GitHub issue unless it's | ||
| security related. When filing a bug remember that the better written the bug is, | ||
| the more likely it is to be fixed. If you think you've found a security | ||
| vulnerability, do not raise a GitHub issue and follow the instructions in our | ||
| [security policy](./SECURITY.md). | ||
| | ||
| ## Contributing to the WebLogic Remote Console repository | ||
| ## Contributing code | ||
| | ||
| Pull requests can be made under | ||
| [The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA). | ||
| We welcome your code contributions. Before submitting code via a pull request, | ||
| you will need to have signed the [Oracle Contributor Agreement][OCA] (OCA) and | ||
| your commits need to include the following line using the name and e-mail | ||
| address you used to sign the OCA: | ||
| | ||
| For pull requests to be accepted, the bottom of your commit message must have | ||
| the following line using your name and e-mail address as it appears in the | ||
| OCA Signatories list. | ||
| | ||
| ``` | ||
| ```text | ||
| Signed-off-by: Your Name <you@example.org> | ||
| ``` | ||
| | ||
| This can be automatically added to pull requests by committing with: | ||
| This can be automatically added to pull requests by committing with `--sign-off` | ||
| or `-s`, e.g. | ||
| | ||
| ``` | ||
| git commit --signoff | ||
| ```text | ||
| git commit --signoff | ||
| ``` | ||
| | ||
| Only pull requests from committers that can be verified as having | ||
| signed the OCA can be accepted. | ||
| Only pull requests from committers that can be verified as having signed the OCA | ||
| can be accepted. | ||
| | ||
| ### Pull request process | ||
| ## Pull request process | ||
| | ||
| 1. Fork this repository | ||
| 1. Ensure there is an issue created to track and discuss the fix or enhancement | ||
| you intend to submit. | ||
| 1. Fork this repository. | ||
| 1. Create a branch in your fork to implement the changes. We recommend using | ||
| the issue number as part of your branch name, e.g. `1234-fixes` | ||
| the issue number as part of your branch name, e.g. `1234-fixes`. | ||
| 1. Ensure that any documentation is updated with the changes that are required | ||
| by your fix. | ||
| by your change. | ||
| 1. Ensure that any samples are updated if the base image has been changed. | ||
| 1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly | ||
| what your changes are meant to do and provide simple steps on how to validate | ||
| your changes. Ensure that you reference the issue you created as well. | ||
| We will assign the pull request to 2-3 people for review before it is merged. | ||
| what your changes are meant to do and provide simple steps on how to validate. | ||
| your changes. Ensure that you reference the issue you created as well. | ||
| 1. We will assign the pull request to 2-3 people for review before it is merged. | ||
| | ||
| ## Code of conduct | ||
| | ||
| Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd | ||
| like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC]. | ||
| | ||
| [OCA]: https://oca.opensource.oracle.com | ||
| [COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Copyright (c) 2020, 2023, Oracle and/or its affiliates. | ||
| # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl. | ||
| | ||
| MAVEN_TARGET = clean install | ||
| | ||
| all: | ||
| [ -z "$$https_proxy" ] || export ELECTRON_GET_USE_PROXY=true GLOBAL_AGENT_HTTPS_PROXY=$$https_proxy GLOBAL_AGENT_NO_PROXY="$$no_proxy"; \ | ||
| export PUPPETEER_SKIP_DOWNLOAD=true CHROMEDRIVER_SKIP_DOWNLOAD=true; \ | ||
| mvn -B ${MAVEN_TARGET} ${MAVEN_FLAGS} | ||
| rm -rf runnable | ||
| unzip -q -d runnable installer/target/console.zip | ||
| mv runnable/console/* runnable | ||
| rm -r runnable/console | ||
| | ||
| clean: | ||
| mvn clean | ||
| rm -rf runnable |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,53 @@ | ||
| | ||
| # WebLogic Remote Console | ||
| | ||
| The WebLogic Remote Console is a lightweight, open source console that you can use to manage your WebLogic Server domain running anywhere, such as on a physical or virtual machine, in a container, Kubernetes, or in the Oracle Cloud. The Remote Console does not need to be colocated with the WebLogic Server domain. | ||
| The WebLogic Remote Console is a lightweight, open source console that you can use to manage your WebLogic Server domain running anywhere, such as on a physical or virtual machine, in a container, Kubernetes, or in the Oracle Cloud. The WebLogic Remote Console does not need to be colocated with the WebLogic Server domain. | ||
| | ||
| You can install and run the Remote Console anywhere, and connect to your domain using WebLogic REST APIs. You simply launch the desktop application and connect to the Administration Server of your domain. Or, you can start the console server, launch the console in a browser and then connect to the Administration Server. | ||
| You can install and run the WebLogic Remote Console anywhere, and connect to your domain using WebLogic REST APIs. You simply launch the desktop application and connect to the Administration Server of your domain. Or, you can start the console server, launch the console in a browser and then connect to the Administration Server. | ||
| | ||
| The Remote Console is fully supported with WebLogic Server 12.2.1.3, 12.2.1.4, and 14.1.1. | ||
| | ||
| Ready to download and use the Remote Console? See [Get Started](#start). | ||
| The WebLogic Remote Console is fully supported with WebLogic Server 12.2.1.3, 12.2.1.4, and 14.1.1.0. | ||
| | ||
| ## Key Features of the WebLogic Remote Console | ||
| The WebLogic Remote Console provides an alternative WebLogic Server administration GUI that enables REST-based access to WebLogic management information, in alignment with current cloud-native trends. When connected to a WebLogic domain using the Remote Console, you can: | ||
| * Configure WebLogic Server instances | ||
| * Configure WebLogic Server clusters | ||
| The WebLogic Remote Console provides an alternative WebLogic Server administration GUI that enables REST-based access to WebLogic management information, in alignment with current cloud-native trends. When connected to a WebLogic domain using the WebLogic Remote Console, you can: | ||
| * Configure WebLogic Server instances and clusters | ||
| * Create or modify WDT metadata models | ||
| * Configure WebLogic Server services, such as database connectivity (JDBC), and messaging (JMS) | ||
| * Deploy and undeploy applications | ||
| * Start and stop servers and applications | ||
| * Monitor server and application performance | ||
| * View server and domain log files | ||
| * View application deployment descriptors | ||
| * Edit selected runtime application deployment descriptor elements | ||
| | ||
| | ||
| ## Differences With the WebLogic Server Administration Console | ||
| If you are already familiar with the WebLogic Server Administration Console deployed as part of your WebLogic domain, you'll notice these key differences in the WebLogic Remote Console: | ||
| * The user interface has been completely redesigned to conform to the Oracle Alta UI Design system and the Oracle Redwood theme included with Oracle JET. | ||
| * The configuration and monitoring content is separated into separate pages in the Remote Console. In the WebLogic Server Administration Console, the configuration and runtime information is presented on one page. See [Separation of Configuration and Runtime Data](site/console_uidesign.md#separation). | ||
| * The Change Center is now expressed as a shopping cart. See [Use the Shopping Cart](site/console_uidesign.md#cart). | ||
| * Instead of logging directly into the Administration Console deployed in a WebLogic domain, the Remote Console connects to the Administration Server in a WebLogic domain, with the credentials supplied by the user, using WebLogic REST APIs. | ||
| ## Getting Started | ||
| You can install the WebLogic Remote Console as a desktop or browser application, depending on your usecases although the desktop application is recommended. Both versions are available to download from [https://github.com/oracle/weblogic-remote-console/releases](https://github.com/oracle/weblogic-remote-console/releases). | ||
| | ||
| ## Get Started <a name ="start"></a> | ||
| You can access the Remote Console through your browser or by running a desktop application. Both versions are available to download from [https://github.com/oracle/weblogic-remote-console/releases](https://github.com/oracle/weblogic-remote-console/releases). The browser installer, `console.zip`, consists of the Remote Console JAR file and associated libraries necessary to use the console. For the desktop application, simply run the appropriate installer for your operating system. | ||
| Review the system requirements at [Get Started](https://oracle.github.io/weblogic-remote-console/setup/) | ||
| | ||
| You should also download and install the Remote Console extension for your WebLogic Server domain. The extension provides additional functionality that is not available with the console alone. Although installing the extension is optional, we recommend that you install it to get the optimum functionality from the Remote Console. | ||
| You should also download and install the WebLogic Remote Console extension for your WebLogic Server domain. The extension provides additional functionality that is not available with the console alone. Although installing the extension is optional, we recommend that you install it to get the optimum functionality from the WebLogic Remote Console. | ||
| | ||
| For details about installing and running the Remote Console, see [Install and Configure the WebLogic Remote Console](site/install_config.md). | ||
| Documentation for the WebLogic Remote Console is [available here](https://oracle.github.io/weblogic-remote-console/setup/). | ||
| | ||
| To build the Remote Console from source, see the [Developer Guide](site/developer_guide.md). | ||
| To build the WebLogic Remote Console from source, see the [Developer Guide](https://oracle.github.io/weblogic-remote-console/develop/build-source/). | ||
| | ||
| ## Known Issues | ||
| See the following list of [Known Issues](site/known_issues.md), limitations, and workarounds. | ||
| | ||
| ## Additional Information | ||
| | ||
| * For information about the console user interface, see [Console Design and Usage Notes](site/console_uidesign.md). | ||
| * For information for tuning the environment, see [Tuning the Remote Console Environment](site/tuning.md). | ||
| * For information for developers, such as building the Remote Console from source, see the [Developer Guide](site/developer_guide.md). | ||
| * For information to help troubleshoot configuration issues, see [Troubleshoot](site/troubleshoot.md). | ||
| See the following list of [Known Issues](https://oracle.github.io/weblogic-remote-console/reference/known_issues/), limitations, and workarounds. | ||
| | ||
| ## Need more help? Have a suggestion? Come and say, "Hello!" | ||
| | ||
| We have a **public Slack channel** where you can get in touch with us to ask questions about using the Remote Console or give us feedback | ||
| We have a **public Slack channel** where you can get in touch with us to ask questions about using the WebLogic Remote Console or give us feedback | ||
| or suggestions about what features and improvements you would like to see. We would love to hear from you. To join our channel, | ||
| please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/). The invitation email will include | ||
| please [visit this site to get an invitation](https://join.slack.com/t/oracle-weblogic/shared_invite/zt-1lnz4kpci-WdY2gWfeJc5jS_a_1Z06MA). The invitation email will include | ||
| details of how to access our Slack workspace. After you are logged in, please come to `#remote-console` and say, "hello!" | ||
| | ||
| ## Contributing | ||
| | ||
| This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md) | ||
| | ||
| ## Security | ||
| | ||
| Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process | ||
| | ||
| ## License | ||
| | ||
| Copyright (c) 2020, 2023 Oracle and/or its affiliates. | ||
| | ||
| Released under the Universal Permissive License v1.0 as shown at | ||
| <https://oss.oracle.com/licenses/upl/>. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,38 @@ | ||
| # Reporting Security Vulnerabilities | ||
| # Reporting security vulnerabilities | ||
| | ||
| Oracle values the independent security research community and believes that responsible disclosure of security vulnerabilities helps us ensure the security and privacy of all our users. | ||
| Oracle values the independent security research community and believes that | ||
| responsible disclosure of security vulnerabilities helps us ensure the security | ||
| and privacy of all our users. | ||
| | ||
| Please do NOT raise a GitHub Issue to report a security vulnerability. If you believe you have found a security vulnerability, please submit a report to secalert_us@oracle.com preferably with a proof of concept. We provide additional information on [how to report security vulnerabilities to Oracle](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html) which includes public encryption keys for secure email. | ||
| Please do NOT raise a GitHub Issue to report a security vulnerability. If you | ||
| believe you have found a security vulnerability, please submit a report to | ||
| [secalert_us@oracle.com][1] preferably with a proof of concept. Please review | ||
| some additional information on [how to report security vulnerabilities to Oracle][2]. | ||
| We encourage people who contact Oracle Security to use email encryption using | ||
mriccell marked this conversation as resolved. Show resolved Hide resolved | ||
| [our encryption key][3]. | ||
| | ||
| We ask that you do not use other channels or contact project contributors directly. | ||
| We ask that you do not use other channels or contact the project maintainers | ||
| directly. | ||
| | ||
| Non-vulnerability related security issues such as new great new ideas for security features are welcome on GitHub Issues. | ||
| Non-vulnerability related security issues including ideas for new or improved | ||
| security features are welcome on GitHub Issues. | ||
| | ||
| ## Security Updates, Alerts and Bulletins | ||
| ## Security updates, alerts and bulletins | ||
| | ||
| Security updates will be released on a regular cadence. Many of our projects will typically release security fixes in conjunction with the [Oracle Critical Patch Update](https://www.oracle.com/security-alerts/) program. Security updates are released on the Tuesday closest to the 17th day of January, April, July and October. A pre-release announcement will be published on the Thursday preceding each release. Additional information, including past advisories, is available on our [Security Alerts](https://www.oracle.com/security-alerts/) page. | ||
| Security updates will be released on a regular cadence. Many of our projects | ||
| ||
| will typically release security fixes in conjunction with the | ||
| Oracle Critical Patch Update program. Additional | ||
| information, including past advisories, is available on our [security alerts][4] | ||
| page. | ||
| | ||
| ## Security-Related Information | ||
| ## Security-related information | ||
| | ||
| We will provide security related information such as a threat model, considerations for secure use, or any known security issues in our documentation. Please note that labs and sample code are intended to demonstrate a concept and may not be sufficiently hardened for production use. | ||
| We will provide security related information such as a threat model, considerations | ||
| for secure use, or any known security issues in our documentation. Please note | ||
| that labs and sample code are intended to demonstrate a concept and may not be | ||
| sufficiently hardened for production use. | ||
| | ||
| [1]: mailto:secalert_us@oracle.com | ||
| [2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html | ||
| [3]: https://www.oracle.com/security-alerts/encryptionkey.html | ||
| [4]: https://www.oracle.com/security-alerts/ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.