Introduction

Pextra CloudEnvironment® is a modern private cloud management and virtualization platform. It is capable of managing globally-distributed datacenters and provides a unified, multi-tenant management interface for all resources. It is designed to be highly scalable and flexible, with a focus on security and ease of use. Storage, networking, and compute resources are completely abstracted and software-defined, allowing for easy management and automation of all aspects of the deployment.

This guide provides rich user documentation on how to install, administer, and use Pextra CloudEnvironment®. This guide assumes minimal prior knowledge, and is designed to be accessible to users of all skill levels, from beginners to experts.

License

This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license.

Pre-Installation Steps

Before installing Pextra CloudEnvironment®, ensure that you have completed all the items in this checklist. This will help ensure a smooth installation process and optimal performance of your private cloud environment.

a) Check System Requirements

1. Review the system requirements for Pextra CloudEnvironment®.
2. Check for any unsupported configurations that may affect your installation.
3. For production workloads, review the officially-supported servers list for optimal performance.

b) Obtain a License Key

1. Visit portal.pextra.cloud to purchase or copy your license key (to get a free evaluation license, fill out the form here).
2. Keep your license key handy, as you will need it during installation.

c) Prepare Installation Media

1. Download the Pextra CloudEnvironment® ISO from the portal or the link provided in your license email.
2. Verify the ISO checksum to ensure file integrity and authenticity.
3. Prepare a bootable USB drive for installation.

d) Back Up Existing Data

1. Back up any existing data on the servers that will be used for installation, as the installation process may overwrite existing data.

Additional Resources

1. Familiarize yourself with the support subscriptions available for Pextra CloudEnvironment®.
2. Join the community forums for additional support and to connect with other users.
3. Review other documentation pages for detailed guides and troubleshooting tips.

System Requirements

In this section, the system requirements, including CPU, memory, storage, and network requirements, are outlined for the Pextra CloudEnvironment® platform.

Hardware Requirements

Every node running Pextra CloudEnvironment® must meet the following minimum hardware requirements. These requirements are designed to ensure optimal performance and reliability of the platform.

Minimum Hardware Requirements

Recommended Hardware Requirements

Notes

1. The platform is only supported on 64-bit CPUs with the x86_64 (amd64) or aarch64 (arm64) architectures. arm64 support was added in release 1.10.5+6816a0c. 32-bit CPUs will never be supported. ↩

2. These extensions are supported by all modern CPUs. The platform may function without virtualization extensions (VT-x/AMD-V), but AVX2 is a strict requirement. Running the platform without virtualization extensions is not supported nor recommended. ↩

Officially-Supported Servers

The following enterprise-grade servers are officially supported by Pextra CloudEnvironment® and have been tested for compatibility and performance. These servers are recommended for production environments and are known to work well with the platform.

Generally, any server that meets the minimum hardware requirements should work with Pextra CloudEnvironment®. However, we recommend using enterprise-grade servers for production environments to ensure optimal performance and reliability.

Notes

1. Hardware-based RAID cards are NOT supported. Please see the Unsupported Configurations section for more information. ↩

Unsupported Configurations

Pextra CloudEnvironment® runs on a variety of hardware configurations, but there are certain configurations that are not supported. This list is not exhaustive, but it covers the most common unsupported configurations. If you encounter any issues with your server configuration, please contact support for assistance.

Hardware-Based RAID Cards

Hardware-based RAID cards are NOT supported. The platform requires direct access to the underlying storage devices for optimal performance and reliability. Hardware RAID can introduce complexity and potential issues with data integrity, especially in virtualized environments.

Workaround: For each disk, create a RAID0 (striped) array with a single disk.

32-Bit CPUs

Pextra CloudEnvironment® does not support 32-bit CPUs. The platform requires a 64-bit CPU. 32-bit CPUs will never be supported.

Workaround: Use a different server with a 64-bit CPU architecture.

Installation

This section provides instructions for downloading the installation ISO, and preparing it for installation. It includes steps for creating the bootable USB drives or DVD, as well as running the Pextra CloudEnvironment® installer on your server.

Downloading the Installer

1. Log into the Pextra Customer Portal.

2. Click on “Download ISO”, then click on “Generate” to generate download links for the latest version of Pextra CloudEnvironment®:

3. Click on the download link to download the ISO file.

After the download is complete, it is strongly recommended to verify the integrity of the downloaded ISO file using the SHA256 and GPG signatures provided on the download page.

Verify File Integrity

Follow the instructions below for your operating system to verify the file integrity. If at any point, file integrity verification fails, do not proceed with the installation.

Before verifying GPG signatures, download our GPG public key.

Linux

Linux users can use the sha256sum and gpg commands to verify the SHA256 checksum and GPG signature of the downloaded ISO file. sha256sum is usually pre-installed on most Linux distributions, while gpg is also commonly available. If you do not have gpg installed, you can install it using your package manager (e.g., apt, pacman, yum, etc.).

SHA256 Checksum

1. Make sure to download the SHA256 checksum file (the file that ends with .sha256) from the Pextra Customer Portal.
2. Open a terminal and navigate to the directory where the downloaded ISO file and SHA256 checksum file are located.
3. Calculate the SHA256 checksum of the downloaded ISO file using the following command:

   sha256sum pextra-ce.iso
   

4. Compare the output with the SHA256 checksum provided on the download page. If they match, the file is intact.

GPG Signature

Two signatures are provided: one for the SHA256 checksum file and one for the ISO file itself. Verifying the SHA256 checksum file is sufficient and faster.

1. Make sure to download the GPG signature file (the file that ends with .sha256.asc) from the Pextra Customer Portal.
2. Import the Pextra Inc. GPG public key using the following command:

   gpg --import pextra-gpg-key.asc
   

3. Verify the SHA256 checksum file using the following command:

   gpg --verify pextra-ce.iso.sha256.asc pextra-ce.iso.sha256
   

4. If the output indicates that the signature is valid, the file is intact. If it indicates that the signature is not valid, do not proceed with the installation.

Verifying the ISO file itself is similar:

1. Make sure to download the GPG signature file (the file that ends with .iso.asc) from the Pextra Customer Portal.
2. Verify the ISO file using the following command:

   gpg --verify pextra-ce.iso.asc pextra-ce.iso
   

3. If the output indicates that the signature is valid, the file is intact. If it indicates that the signature is not valid, do not proceed with the installation.

MacOS

MacOS users can use the shasum and gpg commands to verify the SHA256 checksum and GPG signature of the downloaded ISO file.

SHA256 Checksum

1. Make sure to download the SHA256 checksum file (the file that ends with .sha256) from the Pextra Customer Portal.
2. Open a terminal and navigate to the directory where the downloaded ISO file and SHA256 checksum file are located.
3. Calculate the SHA256 checksum of the downloaded ISO file using the following command:

   shasum -a 256 pextra-ce.iso
   

4. Compare the output with the SHA256 checksum provided on the download page. If they match, the file is intact.

GPG Signature

1. Make sure to download the GPG signature file (the file that ends with .sha256.asc) from the Pextra Customer Portal.
2. Import the Pextra Inc. GPG public key using the following command:

   gpg --import pextra-gpg-key.asc
   

3. Verify the SHA256 checksum file using the following command:

   gpg --verify pextra-ce.iso.sha256.asc pextra-ce.iso.sha256
   

4. If the output indicates that the signature is valid, the file is intact. If it indicates that the signature is not valid, do not proceed with the installation.

Verifying the ISO file itself is similar:

1. Make sure to download the GPG signature file (the file that ends with .iso.asc) from the Pextra Customer Portal.
2. Verify the ISO file using the following command:

   gpg --verify pextra-ce.iso.asc pextra-ce.iso
   

3. If the output indicates that the signature is valid, the file is intact. If it indicates that the signature is not valid, do not proceed with the installation.

Windows

Windows users can use the CertUtil PowerShell command to verify the SHA256 checksum. For GPG signatures, GPG4Win can be used, as Windows does not have a built-in method to verify GPG signatures. GPG4Win is free and open source software.

SHA256 Checksum

1. Make sure to download the SHA256 checksum file (the file that ends with .sha256) from the Pextra Customer Portal.
2. Open PowerShell and navigate to the directory where the downloaded ISO file and SHA256 checksum file are located.
3. Calculate the SHA256 checksum of the downloaded ISO file using the following command:

   CertUtil -hashfile pextra-ce.iso SHA256
   

4. Compare the output with the SHA256 checksum provided on the download page. If they match, the file is intact.
5. If the output does not match, do not proceed with the installation.

GPG Signature

1. Download the latest version of GPG4Win and install it.
2. Make sure to download the GPG signature file (the file that ends with .sha256.asc) from the Pextra Customer Portal.
3. Open PowerShell and navigate to the directory where the downloaded ISO file and GPG signature file are located.
4. Import the Pextra Inc. GPG public key using the following command:

   gpg --import pextra-gpg-key.asc
   

5. Verify the SHA256 checksum file using the following command:

   gpg --verify pextra-ce.iso.sha256.asc pextra-ce.iso.sha256
   

6. If the output indicates that the signature is valid, the file is intact. If it indicates that the signature is not valid, do not proceed with the installation.

Verifying the ISO file itself is similar:

1. Make sure to download the GPG signature file (the file that ends with .iso.asc) from the Pextra Customer Portal.
2. Verify the ISO file using the following command:

   gpg --verify pextra-ce.iso.asc pextra-ce.iso
   

3. If the output indicates that the signature is valid, the file is intact. If it indicates that the signature is not valid, do not proceed with the installation.

Preparing Installation Media

Now that you have downloaded the ISO installer, you need to create a bootable USB drive or DVD. Follow the instructions below for your operating system to create the installation media.

Linux

Linux users can use the dd command to create a bootable USB drive. dd is a built-in command and does not require any additional software.

1. Insert a USB drive with at least 8GB of space. Make sure to back up any important data on the drive, as it will be formatted.
2. Open a terminal and run the command lsblk to identify the device name of the USB drive (e.g., /dev/sdX, where X is the letter assigned to your USB drive).
3. Unmount the USB drive using the command (you may need to use sudo):

    umount /dev/sdX*
   

4. Use the dd command to create a bootable USB drive. Replace /path/to/pextra-ce.iso with the path to the downloaded ISO file and /dev/sdX with the device name of your USB drive (e.g., /dev/sdb):

   dd if=/path/to/pextra-ce.iso of=/dev/sdX bs=4M status=progress
   

5. After the process is complete, run the following command to ensure all data is written to the USB drive:

   sync
   

6. Safely eject the USB drive using the command (you may need to use sudo):

   eject /dev/sdX
   

Your USB drive is now ready to be used for installation.

MacOS

MacOS users can also use the dd command to create a bootable USB drive. The process is similar to Linux, but with some differences in the commands used.

1. Insert a USB drive with at least 8GB of space. Make sure to back up any important data on the drive, as it will be formatted.
2. Open a terminal and run the command diskutil list to identify the device name of the USB drive (e.g., /dev/diskX, where X is the number assigned to your USB drive).
3. Unmount the USB drive using the command (you may need to use sudo):

   diskutil unmountDisk /dev/diskX
   

4. Use the dd command to create a bootable USB drive. Replace /path/to/pextra-ce.iso with the path to the downloaded ISO file and /dev/diskX with the device name of your USB drive (e.g., /dev/disk2):

   sudo dd if=/path/to/pextra-ce.iso of=/dev/diskX bs=4m status=progress
   

5. After the process is complete, run the following command to ensure all data is written to the USB drive:

   sync
   

6. Safely eject the USB drive using the command (you may need to use sudo):

   diskutil eject /dev/diskX
   

Your USB drive is now ready to be used for installation.

Windows

Windows users can use Rufus in DD mode to create a bootable USB drive, as there is no built-in mechanism to create bootable USB drives from ISO files. Rufus is free and open source software.

1. Download the latest version of Rufus and run it.

2. Insert a USB drive with at least 8GB of space. Make sure to back up any important data on the drive, as it will be formatted. In Rufus, select the USB drive by clicking on the “Device” dropdown menu:

   

3. Select the downloaded ISO file by clicking on the “SELECT” button. Navigate to the location where you saved the ISO file and select it:

   

4. With the USB and ISO ready, the window should similar to this. Click on “START” button to begin the process:

   

5. A pop-up window will appear. Select “Write in DD Image mode” and click “OK”:

   

6. Another pop-up window will appear, warning you that all data on the USB drive will be erased. Click “OK” to proceed:

   

7. Once the process is complete, the bar will be green and say “READY”. You can close Rufus:

   

8. Safely eject the USB drive from your computer.

Your USB drive is now ready to be used for installation.

Booting from the Installation Media

1. Insert the bootable USB drive or DVD into the server.
2. Power on the server and enter the BIOS/UEFI settings (usually by pressing F2, F10, or DEL during startup).
3. Change the boot order to prioritize the USB drive or DVD.
4. Save the changes and exit the BIOS/UEFI settings.
5. The server should boot from the installation media, and you will see the bootloader screen:

Press the Enter key to start the installation process. You can now proceed with the installation steps.

Installation Steps

Follow the steps below to install Pextra CloudEnvironment® on your server.

Steps

1. Acknowledge the End User License Agreement (EULA).

2. Configure the management network.

   • The installer will automatically detect network interface configuration from DHCP.
   • The server IP must not change after installation. It will cause breakage.
   • If your network interface does not appear, please let us know.

3. Enter your license key.

   • If you do not have a license key, refer to the Pre-Installation section for more information on obtaining a license.

4. Configure the default organization and timezone.

   • This is the root organization (the owner of the deployment) that has access to all resources.
   • Additional organizations can be created later.
   • It is highly recommended to set the timezone to Etc/UTC, however, you can choose your local timezone if needed.

5. Configure the administrator user.

   • This user is the root user of the deployment and has access to all resources.
   • Choose a strong password and make sure to remember it.
   • After the installation, it is recommended to create an additional user with limited permissions for day-to-day operations.
   • For command-line access, the Linux user root’s password is set to the same password as the administrator user.

6. Configure the boot disk.

   • The installer will automatically detect available disks. Choose the disk where you want to install the operating system.
   • The installer will format the selected disk, so make sure to back up any important data before proceeding.

7. Finalize the installation.

   • A summary of your configuration will be displayed. Review the settings and click “Install” to begin the installation process.

8. Wait for the installation to complete.

   • The installation process may take some time, depending on your network speed and hardware configuration. Typically, it takes about 20-30 minutes.
   • If you see any errors during the installation, please let us know.

9. Reboot the server.

   • If you did not select “Auto-reboot” during the installation, you will need to click “Reboot” to restart the server.
   • Remove the installation media (USB drive or DVD) before rebooting, otherwise the server may boot from the installation media again.

Your server is now ready to use! To access the web interface, please refer to the Accessing the Web Interface section.

You can now proceed to perform post-installation steps to configure your deployment.

Post-Installation Steps

After the installation is complete, it is recommended to perform some additional steps to ensure that your Pextra CloudEnvironment® deployment is fully functional and optimized for your needs.

a) Upgrade to the latest version:

Refer to the System Upgrade section for instructions on how to upgrade to the latest version.

b) Join the node to an existing cluster (if applicable):

Refer to the Cluster Management section for instructions on how to join a node to a cluster if you are deploying a cluster or joining a node to an existing cluster.

c) Configure user accounts:

Refer to the Identity Access Management (IAM) section for instructions on how to create and manage user accounts and permissions.

d) Configure networking:

Refer to the Network Management section for instructions on how to configure network settings.

e) Configure storage pools:

Refer to the Storage Management section for instructions on how to create and manage storage pools.

f) Monitor system performance:

Refer to the Monitoring & Metrics section for instructions on how to monitor system performance.

Web Interface

This section describes how to access and navigate the web interface of Pextra CloudEnvironment®. The web interface is the primary tool for managing your deployment, allowing you to perform various tasks, monitor system metrics, and configure settings.

Accessing the Web Interface

You can access the Pextra CloudEnvironment® web interface by entering the management IP address in your web browser. The default URL is https://<management-ip>:5007, where <management-ip> is the IP address you configured during the installation process.

Logging In

To log in to the web interface, use the credentials you set during the installation process. The default username is pceadmin, and the password is the one you specified during installation:

Once logged in, you will be directed to the current node’s page¹.

Notes

1. The IP address that you connect to (this is especially relevant for nodes in a cluster). The node that you are currently connected to is shown with a light green dot next to the node’s entry in the resource tree. All requests are proxied to the node that you are connected to. ↩

Resource Tree

On the left side of the web interface, you will find a tree view that displays the hierarchy of your deployment. This view provides a complete overview of all organizations, datacenters, clusters, nodes, and instances within your deployment. You can expand and collapse the tree’s nodes to navigate through the different levels of your infrastructure:

Node Management

This section provides a guide to managing individual nodes within your deployment.

Nodes are the physical or virtual servers¹ that run Pextra CloudEnvironment®. They serve as the foundation of your infrastructure, providing the compute, storage, and network resources required by your deployment.

The ID prefix for nodes is node-².

Notes

1. Running Pextra CloudEnvironment® in a virtual machine is in beta. Try running Pextra CloudEnvironment® inside of Pextra CloudEnvironment®! ↩

2. Resources in Pextra CloudEnvironment® are identified by unique IDs. Node IDs will have the prefix node-, followed by a unique identifier (e.g., node-qthm_iLrflJ_DtSS1l4Gx). ↩

System Upgrade

System upgrades should be routinely performed in order to ensure that the latest bug fixes, security patches, and features are available.

Console

1. Access the node’s console through SSH or through the “Console” tab in the node view.

2. First, update the node’s package index by running the following command:

   apt update
   

   This command may take some time to finish depending on the node’s connection speed.

3. If any system upgrades are available, the following message will be shown:

   [xx] packages can be upgraded. Run 'apt list --upgradable' to see them.
   

   If this message is not shown, the node is on the latest version. No action is required.

4. If the above message is shown, the node can be upgraded to the latest version by running the following command:

   apt upgrade
   

   This command may take a while to finish depending on the number of upgrades and the node’s connection speed.

Set License Key

License keys are long-lived and typically do not need to be changed. However, if you need to change the license key, you can do so by following these steps:

Web Interface

1. Right-click on the node in the resource tree and select Set License Key:

2. A modal will appear. The current license key along with its validity will be displayed. Enter the new license key in the text box and click Confirm:

3. If any errors occur, they will be displayed, otherwise, the modal will close. For example:

To confirm that the license key has been set, you can check the licensing status of the node’s cluster.

Cluster Management

Check Licensing Status

The licensing status of a cluster can be checked to ensure that the license keys for all nodes in the cluster are valid.

Web Interface

1. Select the cluster in the resource tree and view the page on the right. A card with a quick overview of the licensing status will be displayed:
2. For a detailed view, click on the Cluster tab in the right pane. The licensing status of each node in the cluster will be displayed:

Datacenter Management

Organization Management

Identity Access Management (IAM)

Network Management

Storage Management

Instance Management

Monitoring & Metrics

Troubleshooting

Known Issues

Logs & Diagnostics

Reporting Issues

This section provides guidance on how to effectively report issues, bugs, and feature requests related to the software. It includes instructions on collecting logs, creating support tickets, and gathering diagnostic information to assist in troubleshooting and resolution.

Collecting Logs

Seeking Help

This section provides guidance on how to seek help through the appropriate channels, including the official helpdesk and community forum. It also includes tips for effective support tickets to ensure a smooth resolution process.

Official Helpdesk

If you have an active support subscription, you can create a support ticket through our official helpdesk:

1. Navigate to our helpdesk.

2. Log in with your credentials.

3. Click on “Create Ticket”.

4. Complete the ticket submission form with the following information:

   • A clear, descriptive title
   • Detailed description of the issue
   • Steps to reproduce the issue
   • Screenshots or error messages (if applicable)
   • System information and logs (see Collecting Logs)
   • Any troubleshooting steps you’ve already attempted

5. Select the appropriate priority level based on the impact to your operations.

6. Submit the ticket.

Our support team will respond according to the Service Level Agreement (SLA) associated with your support subscription level.

Support Ticket Lifecycle

Each support ticket goes through a lifecycle, which includes the following stages:

1. Submission: You create and submit a ticket.

2. Acknowledgment: Support team acknowledges receipt.

3. Investigation: Support team investigates the issue.

4. Resolution or Escalation: Issue is either resolved or escalated to engineering.

5. Verification: You verify the solution works.

6. Closure: Ticket is closed once you confirm the issue is resolved.

Community Forum

If you do not have an active support subscription or prefer community-based assistance, you can post your issue on our community forum:

1. Visit our community forum.

2. Create an account or log in if you already have one.

3. Navigate to the appropriate section (e.g., “Installation Issues,” “Configuration Help,” etc.).

4. Click on “New Topic” to create a new post.

5. Provide a clear title and detailed description of your issue.

6. Include relevant system information, logs, and any troubleshooting steps you’ve already taken.

7. Submit your post.

Our community members and Pextra staff monitor the forums regularly and will respond as soon as possible. While this option does not have a formal SLA, the community is active and helpful.

Tips for Support Tickets

To ensure that your support ticket is effective and leads to a quick resolution, follow these tips:

1. Be specific: Provide precise details about what you were doing when the issue occurred.

2. Include context: Mention your environment details, such as hardware specifications, current version, and any recent changes.

3. Attach logs: Always include relevant logs (see Gathering Diagnostic Information).

4. Document steps to reproduce: List the exact steps someone would need to follow to encounter the same issue.

5. Describe expected vs. actual behavior: Explain what you expected to happen and what actually happened.

6. Add screenshots: Visual evidence can help the support team understand the issue more quickly.

Gathering Diagnostic Information

Feedback & Contributions

In this section, we encourage users to provide feedback on their experience with the product. This includes suggestions for new features, improvements to existing features, and any other comments or concerns they may have.

We value your feedback and take it seriously. It helps us understand what is working well and what needs improvement.

As an emerging solution, we also appreciate any contributions to our documentation, whether it’s fixing typos, adding examples, or suggesting new topics. If you have a suggestion or contribution, please refer to the Contributing section for guidelines on how to submit your feedback or contribution.

Feature Requests

We continuously improve Pextra CloudEnvironment® based on user feedback and suggestions. If you have ideas for new features or enhancements that would improve your experience, we encourage you to share them with us.

Submitting Feature Requests

The primary channel for submitting feature requests is through our community forums:

1. Visit our community forum.

2. Create an account or log in if you already have one.

3. Navigate to the “Feature Requests” section.

4. Click on “New Topic” to create a new post.

5. Provide a clear, descriptive title for your feature request.

6. In the description, include:

   • A detailed explanation of the requested feature
   • The problem it solves or the value it provides
   • Your use case and why this feature would be beneficial
   • Any relevant examples, screenshots, or mockups (if applicable)

7. Submit your feature request.

What Happens After Submission

After submitting your feature request:

1. Community Discussion: Other users may comment on your request, adding their perspectives or use cases.

2. Feedback Collection: Pextra team members monitor the forums and gather feature requests.

3. Evaluation: Our team evaluates requests based on factors such as:

   • Alignment with product vision
   • Number of users who would benefit
   • Technical feasibility
   • Implementation complexity

4. Prioritization: Approved features are prioritized in our development roadmap.

5. Implementation: When a feature is scheduled for development, we may reach out for additional information.

General Feedback

We value your opinions about Pextra CloudEnvironment® and are committed to continuously improving our product based on user feedback. Your insights help us understand what’s working well and where we can make enhancements to better serve your needs.

Providing General Feedback

The most effective way to share your general feedback is through our community forums:

1. Visit our community forum.

2. Create an account or log in if you already have one.

3. Navigate to the “Feature Requests” section.

4. Click on “New Topic” to create a new post.

5. Provide a descriptive title that summarizes your feedback.

6. In the description, include:

   • Your overall experience with the product
   • Specific aspects you find particularly useful or challenging
   • Any suggestions for improvements
   • Context about your use case and environment

7. Submit your feedback.

Examples of Feedback

We encourage various types of feedback, including:

• Comments on the user interface and experience

• Suggestions for improving our guides and documentation

• Reports about system performance in your environment

• Feedback on how well Pextra CloudEnvironment® works with other tools

• Overall thoughts about the product and its value

How We Use Your Feedback

When you share your feedback:

1. Other users may respond with their own experiences or suggestions.

2. Your feedback directly influences our product roadmap and development priorities.

3. We use your insights to make incremental improvements to the product.

We appreciate you taking the time to share your thoughts with us. Your feedback is essential to helping us build a better product for all users.

Contributing

We welcome contributions to our documentation. Whether you want to fix a typo, add examples, or suggest new topics, your contributions are valuable to us. Below are the guidelines for contributing to our documentation.

How to Contribute

One-Click Contribution

1. If you find a typo or want to suggest an improvement, click the notepad with a pencil icon at the top right of the page:

   • This will take you to the GitHub page for that file.
   • If you are logged in to GitHub, you can edit the file directly in your browser. If you are not logged in, you will be prompted to log in or create an account.

2. Make your changes in the online editor.

3. Click “Propose changes” to create a pull request (PR) with your changes.

   • Commit your changes with a clear and descriptive commit message. We use Conventional Commits for commit messages, so please follow that format:

4. Wait for feedback from the maintainers. They may request changes or approve your PR. Once approved, your changes will be merged into the main repository.

5. Celebrate your contribution! 🎉

Full Development Setup

1. Create a GitHub account if you don’t have one.

2. Fork the repository by clicking the “Fork” button at the top right of the page:

3. Clone your forked repository to your local machine:

   git clone https://github.com/PextraCloud/documentation.git
   

4. Create a new branch for your changes:

   git switch -c <name>/<feature>
   

5. Set up your development environment:

   • Install the necessary dependencies.
   • Follow the instructions in the repository’s README for setting up your local environment.

6. Make your changes to the documentation files.

   • Use Markdown for formatting.
   • Follow the existing style and structure of the documentation.

7. Commit your changes with a clear and descriptive commit message. We use Conventional Commits for commit messages, so please follow that format:

   git add .
   git commit -m "fix: correct typo in installation guide"
   

8. Push your changes to your forked repository:

   git push origin <name>/<feature>
   

9. Create a pull request (PR) to the main repository:

   • Navigate to the original documentation repository.
   • Click on the “Pull Requests” tab.
   • Click on “New Pull Request.”
   • Select your branch and click “Create Pull Request.”
   • Provide a clear description of your changes and why they are needed.

10. Wait for feedback from the maintainers. They may request changes or approve your PR. Once approved, your changes will be merged into the main repository.

11. Celebrate your contribution! 🎉