Skip to content
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

Update suse.md document for package name #10439

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Conversation

manojs1978
Copy link
Contributor

Prepare


Description

Target issue

closes #issue-number-here
#10438

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • I confirm that there is no impact on the docs due to the code changes in this PR.

@manojs1978 manojs1978 requested a review from ossdhaval December 17, 2024 09:55
Copy link

dryrunsecurity bot commented Dec 17, 2024

DryRun Security Summary

The pull request updates the Janssen server installation instructions for SUSE-based Linux distributions, focusing on improving security practices through updated download URLs, package verification, HTTPS configuration, and firewall guidance.

Expand for full summary

Summary:

The changes in this pull request appear to be focused on improving the installation and configuration instructions for the Janssen server on SUSE-based Linux distributions, with a strong emphasis on security best practices. The key changes include updating the download URL and package name, providing instructions for verifying the integrity of the downloaded package using the published SHA256 sum, and guidance on enabling HTTPS communication and firewall configuration. These changes help ensure that the Janssen server can be installed and configured in a secure manner, mitigating potential security risks.

Files Changed:

  • docs/janssen-server/install/vm-install/suse.md: This file contains the updated installation instructions for the Janssen server on SUSE Linux Enterprise Server (SLES) 15 and openSUSE Leap 15.5. The changes include:
    1. Updating the download URL for the Janssen server package to use the correct version number.
    2. Updating the instructions for verifying the integrity of the downloaded package using the published SHA256 sum to match the new file name.
    3. Updating the installation command to use the correct package name.
    4. Providing guidance on opening the HTTPS port (443) in the server firewall and enabling HTTPS communication for secure client-server communication.
    5. Documenting the uninstallation process to ensure a clean and complete removal of the software.

These changes demonstrate a strong focus on security best practices, such as secure downloads, firewall configuration, and HTTPS enablement, which are crucial for ensuring the overall security of the Janssen server deployment.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

View PR in the DryRun Dashboard.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs labels Dec 17, 2024
@manojs1978 manojs1978 requested review from moabu and MohitMaliFtechiz and removed request for moabu December 20, 2024 07:44
@manojs1978 manojs1978 merged commit 9175591 into main Dec 20, 2024
11 checks passed
@manojs1978 manojs1978 deleted the manojs1978-susedoc_update branch December 20, 2024 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants