## How to Enable Firewall Rules on PipeOps 
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;


Firewall rules are essential for controlling network access to and from your deployed applications. By defining clear rules, you can limit access to trusted sources and ensure your applications operate within intended network boundaries. PipeOps provides flexible firewall controls that let you manage both inbound and outbound traffic directly within your project settings.


## Why Firewall Rules Matter
________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;


Firewall rules let you enforce IP policies that define how your application communicates with the outside world. This feature gives you granular control over network access and helps secure your deployment.

You can use firewall rules to:


- Allow only specific IP ranges, helping you meet legal or regulatory requirements.

- Control which ports can communicate with your application.

- Limit access to websites or data to trusted IP addresses.

- Allow outbound access only to specific external services, such as APIs or databases.


\
&nbsp;

## Enabling Firewall Rules

______________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

Firewall rules are currently available as a beta feature on PipeOps. Before you can configure firewall rules, you need to enable this feature:


- Go to your PipeOps dashboard.

- In the left sidebar, click Feature Preview.

![Feature Preview](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Feature_Preview_18ccd0d9e7.png)


- Toggle the switch next to Firewall Rules to enable the feature.


![Enable Beta Features](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Enable_Beta_Features_74b6a1a4db.png)


Once enabled, the Firewall Rules section will appear in your project settings.


## Accessing Firewall Configuration
_____________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;


PipeOps provides a simple interface for setting up firewall rules directly within your project settings.

These rules allow you to define which IP addresses or CIDR blocks can access your deployment, and which ports and protocols are permitted for communication.

To access firewall configuration:

- Go to your project dashboard on PipeOps.

- Select the project you want to configure.

\
&nbsp;

![Project dashboard](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/project_dashboard_3a64dfe24e.png)

\
&nbsp;

- Open the Project Settings tab and choose Firewall Rules from the sidebar.

![Project Settings](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Project_Settings_Tab_09f54522db.png)

\
&nbsp;


## Configuring Firewall Rules

_____________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;


### Select Network Traffic Direction

PipeOps lets you configure rules for:

- **Inbound Traffic:** Controls which sources can send requests to your application.

- **Outbound Traffic:** Controls which destinations your application can send traffic to.

![Inbound-Outbound](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Firewall_Inbound_Outbound_aafc4e5020.png)


Click on the Inbound Traffic or Outbound Traffic tab to configure rules for each direction.


### Define Allowed Sources

Specify which IP addresses or CIDR blocks should be allowed.  CIDR blocks allow you to define a range of IP addresses. For example, 10.0.5.0/24 applies your policy to all IP addresses from 10.0.5.0 to 10.0.5.255.

![Allowed Sources](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Firewall_Allowed_Sources_714fe73b4c.png)

You can also:

- Enter multiple IPs separated by commas
- Use predefined keywords like:

   -  any/all – allows traffic from all sources
    
   -  internal – enables secure inter-service communication within your project



### Specify Ports and Protocols

Enter the port number and select the protocol (TCP/UDP).

Expose multiple ports as needed using the **Add More** button.

![Ports and Protocols](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Firewall_Ports_and_Protocols_f0926c73b0.png)

**Save and Apply**

After configuring your rules, click **Save** to enforce them.



## Demo: Applying a Firewall Policy

_____________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;


We’ve just deployed a sample Adonis project on PipeOps. The app is open to everyone by default. In this example, we’ll tighten security by enforcing firewall rules.


When we click the “View Project” button, the application is publicly accessible. Anyone with the link can access it.

![View Project](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/View_Adonis_Project_ce13f9623e.png)

\
&nbsp;



![Adonis Project](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Adonis_Sample_Project_22d3357c90.png)


For this demonstration, we’ll restrict inbound traffic to only allow connections from my IP address over port 443.

![Add Firewall Rule](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Add_Firewall_Rule_f6a64a499c.png)


After applying the firewall rule, only requests from the allowed IP can access the project. All other requests will receive a 403 error.


To confirm the restriction, we’ll test access from a different IP. As expected, the application returns a 403 error.

![403 Error](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Firewall_403_error_1b866fbfdf.png)



### Securing Your Deployment with Confidence

Firewall rules secure your PipeOps deployments by precisely controlling inbound and outbound network traffic. By restricting access to trusted IP addresses and limiting communication to necessary ports, you significantly reduce your application’s exposure to unauthorized access.










How to Enable Firewall Rules on PipeOps 

# What is PipeOps’ Pay-As-You-Go Model and How Does it Benefit You?

__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

In an industry where infrastructure needs evolve quickly, fixed pricing models often lead to overpaying or underutilizing resources. That’s why PipeOps uses a **Pay-As-You-Go (PAYG)** pricing model. This flexible, transparent approach charges you based on what you actually use.


In this article, you’ll learn how the pay-as-you-go model works at PipeOps, who it’s for, and how it can help you control costs while scaling seamlessly.

\
&nbsp;

## Understanding PipeOps’ Pay-As-You-Go Model  


PipeOps’ pay-as-you-go model means you are billed only for the resources you actually use, rather than paying a fixed fee for pre-allocated resources. At the end of each billing cycle, you are charged based on your real usage, ensuring fairness and eliminating unnecessary costs. 

You pay a flat subscription fee to access PipeOps and its features. However, the amount you pay beyond that depends entirely on how much resources you actually use.

\
&nbsp;

### Built-in Usage Coverage

Every PipeOps plan includes a set amount of Nova usage (our managed cloud servers)  covered by your subscription fee.


Here’s how it works:

Growth Plan: $10/month covers $5 in monthly Nova usage

Scale Plan: $150/month covers $50 in monthly Nova usage

You’re only charged for any usage above this coverage.


\
&nbsp;


## Core Principles of the Pay-As-You-Go Model

\
&nbsp;


- **Resource-Based Billing:** You're only billed for the computing resources you actually consume.

- **No Long-Term Commitments:** PipeOps allows you to scale resources up or down as needed.

- **Transparent Pricing:** All costs are clearly visible in your usage dashboard, with no hidden fees or surprise charges at month-end.


\
&nbsp;

## Key Benefits of PipeOps’ Pay-As-You-Go Model
\
&nbsp;


1. **Cost Efficiency and Fairness**

You avoid paying for unused capacity or features. If your usage is low, you keep costs minimal, and if you need more resources, you pay only for your actual consumption. This eliminates waste and aligns cost with value received.


2. **Scalability and Flexibility**

The PAYG model allows you to scale your cloud infrastructure seamlessly, whether you’re a solo developer or a growing enterprise. This flexibility supports dynamic projects and evolving business needs.


3. **Lower Barrier to Entry**

With a modest monthly subscription to access platform features and usage-based pricing, new users and startups can start small without large upfront costs or commitments. This encourages experimentation and innovation without financial risk.

4. **Transparent and Predictable Billing**

PipeOps provides clear usage metrics and pricing details, helping you forecast expenses and avoid surprises. The included usage credits in each plan provide a baseline, and you only pay for overages, making budgeting easier.


PipeOps’ Pay-As-You-Go model allows you to deploy, manage, and scale cloud infrastructure with unmatched flexibility and cost control. Whether you’re a solo developer, a growing startup, or an enterprise, you benefit from transparent billing and the freedom to pay only for what you use.




What is PipeOps’ Pay-As-You-Go Model?

# How to Roll Back Applications in PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

Even with the best CI/CD pipeline, not every deployment goes smoothly. Maybe a dependency breaks, an environment variable is misconfigured, or the new version simply doesn’t behave as expected.

PipeOps helps you recover quickly. With built-in rollback support, you can revert your application to a previously working version in just a few steps.


## When Should You Roll Back? 

You might consider rolling back a deployment when:


- A new version of your app crashes


- Users report issues after a new release


- You need to temporarily revert while investigating a bug


\
&nbsp;

## How Rollbacks Work in PipeOps

PipeOps keeps track of all previous deployments and commit versions. When you initiate a rollback, it redeploys a prior version of your app based on either Git history or deployment history. 

### Initiating a Rollback 


To roll back your application:

1. **Navigate to your project:** Log in to your PipeOps dashboard and open the project.



2. **Open the Actions menu:** Click the “Actions” button in the top-right corner to reveal the dropdown menu.

![Select Rollback](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Select_Rollback_1_3b69d4b560.png)


3. **Select "Rollback":** This opens the rollback modal with two available options:


### Rollback by Git  


Use this if you want to revert based on a specific Git commit.

- Select the **By Git** tab.

![Rollback by Git](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Rollback_by_Git_1_e66e07126e.png)


- Browse your commit history.


- Choose the commit to roll back to.


- Click **Rollback** to initiate deployment.


#### Rollback by Action

Use this if you want to revert to a specific build from your deployment history.

- Select the **By Action** tab.

![Rollback by Action](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Rollback_by_Action_1_428e49da0a.png)


- View previous builds.


- Choose the build version to roll back to.


- Click **Rollback** to begin.


#### Best Practices

-  Roll back quickly when uptime or user experience is at risk.


- Use meaningful Git commit messages—they help when choosing rollback points.


Once a rollback is triggered, PipeOps immediately starts a redeployment. You’ll see a "rollback triggered successfully" notification at the bottom right of your screen. 

![Rollback Success](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Project_Rollback_Trigerred_1_37702dc021.png)



After the process completes, the rollback appears in your deployment history. You can also confirm that the version you rolled back to is now live by clicking the View Project button at the top right of your dashboard.


Rollbacks are a core part of building resilient applications. When things go wrong, PipeOps makes recovery fast, easy, and reliable.




How to Roll Back Applications in PipeOps

# How to Estimate Your Monthly Costs on PipeOps

__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________


Whether you're managing a solo project or scaling infrastructure across teams, understanding what you’ll pay each month is essential for planning and avoiding billing surprises.

In this guide, we’ll walk you through how PipeOps billing works and show you how to estimate your monthly costs with confidence.

\
&nbsp;

## PipeOps' Pricing Structure  


PipeOps uses a transparent, usage-based pricing model made up of:

- **Cloud Resource Usage:** This reflects the cost of the resources you consume. It varies depending on how much you use during your billing cycle.

- **Monthly Subscription Fee:** A fixed amount that gives you access to the platform and its features.


Each subscription plan includes a fixed amount of Nova usage, which is PipeOps’ managed cloud server. This helps offset your resource charges.

\
&nbsp;

| Plan             | Monthly Fee              | Nova Usage Coverage                                      |
| --------           | -------                         | --------                                          |
| Growth         | ₦15,500                    | Covers ₦7,750 in monthly Nova usage            |
| Scale            | ₦232,500                 | Covers ₦77,500 in monthly Nova usage                    |
| Custom         | Varies                      | Custom usage coverage                                      |

  
\
&nbsp;
 
If your usage exceeds the included amount, you’ll only be billed for the extra.

\
&nbsp;

## How to Estimate Your Monthly Cost  


Here’s a simple way to estimate your monthly bill: 

1. Start with Your Plan  

    First, determine your base subscription fee:

    - **Growth:** ₦15,500
    
    - **Scale:** ₦232,500
    
    - **Custom:** Varies


2. Check Your Resource Usage

    Track your current Nova usage directly in your PipeOps dashboard. This helps you see how much resources you’ve consumed so far.


3. Factor in What Your Plan Covers

    Each plan includes a specific amount of Nova usage that PipeOps covers. Subtract this from your total usage.

If your usage is higher than the covered amount, you’ll only pay for the extra. However, if your usage is within your covered amount, you won’t pay anything extra beyond the subscription.

\
&nbsp;


**Example:**

Let’s say User X is on the Growth Plan, which costs ₦15,500/month and includes ₦7,750 in Nova usage. 

This month, User X’s resource usage on PipeOps reached ₦8,000.

Here’s the breakdown:

Subscription fee: ₦15,500

Usage covered in his plan: ₦7,750

Excess usage: ₦8,000 - ₦7,750 = ₦250

For the next billing cycle, User X only pays: ₦15,500 + ₦250 = ₦15,750

\
&nbsp;


## FAQs

### What About “Bring Your Own Cloud” (BYOC) users?

If you're using your own cloud provider (e.g. AWS, GCP, or Azure), PipeOps does not charge you for infrastructure usage. Here’s how it works:

- You only pay the subscription fee.

- Your cloud provider bills you directly for any resources used on their platform.
 
<br>

### Can I switch plans on PipeOps?

Yes, PipeOps allows you to switch between plans. To do this, go to your dashboard and click the profile icon in the top-right corner. From the dropdown menu, select Billing. On the Billing page, click the **Switch Plan** button, choose your new plan, and confirm the change. Your new plan will take effect in the next billing cycle.

<br>

### How do I add or update my payment method?

Go to the Billing section of your dashboard. Under Payment Method, click **Change** and enter your new card or payment details. Your payments will be charged to the updated method.


How to Estimate Your Monthly Costs on PipeOps

## Getting Started Guide: From SignUp to First Deployment
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

If you're new to PipeOps and looking to get your projects up and running quickly, you’re in the right place. This step-by-step guide will walk you through the entire onboarding process—from creating your account to deploying your first project on the platform.  Whether you’re an individual developer or part of a growing team, this tutorial will help you navigate the platform with ease.

This guide will cover three phases:
- Seting up your account
- Choosing your server hosting method
- Project deployment


\
&nbsp;


## Setting Up Your Account​


### Step 1: Visit the homepage 

Open your preferred web browser and navigate to the PipeOps homepage. 
You can use the direct URL: https://pipeops.io.

![landing page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Landing_Page_9b764ca22e.png)


On the homepage, click the "Sign Up" button at the top right corner of your screen. This will take you to the registration page. 

![landing page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Signup_f5cb1af420.png)


### Step 2: Sign Up

PipeOps offers four different sign-up options. You can create an account using one of the following:

- GitHub account.
- GitLab account.
- BitBucket account.
- Email address and password.

If you choose GitHub, GitLab, or Bitbucket, ensure that you're already logged into your account. You'll be prompted to authorize PipeOps to connect to your account.

![SigUp Options](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Sign_Up_Credentials_2ada798019.png)


### Step 3: Enter email address and password 

For this guide, we’ll be going with the email sign-up option. Here, you’ll be asked to enter your full name and a valid email address. After that, set a strong password for your account and hit the “proceed” button. 


### Step 4: Verify your email address

After submitting your details, you’ll be redirected to a page requesting your OTP (one-time password). Check your email inbox for the OTP, copy the code, and enter it into the field. Click the “submit” button to proceed. 

![Email Verification](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Verify_OTP_46fc92ff92.png)


### Step 5: Customize your workspace
The next step in your account creation process is to customize your workspace. We want to understand your goal of using PipeOps to provide you with the most relevant features and support. Take a moment to answer the following questions:

**Workspace name**

The first field is to provide a name for your workspace. Your workspace name helps you organize and distinguish your projects within PipeOps.

![Workspace name](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/choose-workspace-name.png)


**Your Role/Job Title**

Choose a role that best describes you from the available options. If your job title is not listed, you can pick “Others” and continue to the next.

![Role](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/role-survey-question.png)


**Project Type**

The next question asks your goal of using the platform. You can select from options, such as exploring PipeOps for your startup, personal project, or open-source project. 

![Goal](https://d23lxlhhocltbo.cloudfront.net/wp-content/uploads/2024/06/28015249/2-2.png)


**Discovering PipeOps**

The final question inquires how you discovered PipeOps. This helps us know how we can reach more people.

![Discover ](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/discovery-survey-question.png)

Click the “Finish” button once you’ve answered this question. Your workspace will be configured accordingly. Now, we can proceed to create a server. 


## Choose your Server Hosting Method 

### Step 1: Select your server hosting option

After the previous step, you’ll be prompted to choose your deployment path. You can decide to deploy your server “On PipeOps” or “On Cloud Provider”. For this guide, we’ll go for the “On Cloud” deployment path.

![Choose path](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_on_pipeops_hosting_475e03e654.png)


### Step 2: Customize your server

After choosing your deployment path, you’ll be directed to:

- Select a cloud provider for your PipeOps Nova server.
- Choose your preferred region: The geographic location for deploying your server. 


![Customize server](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_customize_server_3a0c84e1c7.png)

Click the “Proceed” button to continue.

### Step 3: Select a Plan

Next, you'll see the different subscription plans available on the platform. PipeOps offers three plans: **Growth, Scale,** and **Custom**, with monthly or yearly billing options. 

![Select plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_select_plan_b871927ba5.png)


### Step 4: Add payment method

After selecting your preferred plan, a payment modal will appear. Review your subscription and add a payment method. 

You can choose from popular payment options like Stripe and Paystack. After that, click the “Proceed to Subscribe” button. This takes you to the secure checkout page. 

![confirm plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_plan_confirm_3182ef5201.png)

### Step 5: Access your Dashboard

Once your payment has been processed, you can now access your dashboard. The next phase is to deploy a project into our newly-created PipeOps server.  

![Access dashboard](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_server_fee7f7b276.png)

<br>


## Project Deployment

### Step 1: Connect your GitHub repository

To deploy your project, you need to first connect your repository provider to PipeOps. For this guide, we’ll be deploying from GitHub, so we’ll select the “Deploy from GitHub” option.

![Connect GitHub](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Connect_Git_e8b8bfc0ac.png)

Authenticate your account to establish a connection between PipeOps and your repository. After successfully linking your Git account, your repository will be available on your dashboard. 

![Linked GitHub](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Linked_Git_Hub_c3cac2e4c2.png)

### Step 2: Select repo source

Click on “Select Git provider account” to reveal a dropdown list from which you can choose “GitHub” or the particular Git provider you linked. Next, click “Select/Add organization” to select your repo organization from the dropdown.

![Select Git Account](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Select_Git_Account_fae45219eb.png)

Now, you can select your repository and the branch you would like to deploy. Click the “Proceed” button to continue. 

![Select Git Branch](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Select_Git_Branch_e14ca71f0c.png)


### Step 3: Configure project

Your Project Summary dashboard will be shown to you. From this page, you can change your project name, select deployment environment, and configure CPU and memory. You can leave everything as default and click Proceed. 

![Project Summary](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Project_Summary_b0166cf4e3.png)

### Step 4: Configure build settings

The next page is for configuring build settings. In build settings > framework, specify your project’s framework. A compatible project build method is set automatically for you. If it’s not, you can choose from the dropdown.

![Project Build](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Project_Build_c29ce0da1f.png)


### Step 5: Deploy project
After reviewing your settings, click the Deploy button. The build process will start and you’ll be able to monitor the logs.

![Project Build Logs](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Project_Build_Logs_57fc0e88e0.png)

Once your project deploys, you’ll see a modal stating that the project has been deployed successfully. Click on “Got it” to go to your project's overview page. 

 ![Successful Project Deployment](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/project-successful-deployment.png)



## Conclusion

And that’s it! You’ve successfully set up your PipeOps account, customized your workspace and server, and deployed your first project. PipeOps is designed to simplify cloud deployment and infrastructure management, and now you’re equipped to explore its full capabilities.







Getting Started with PipeOps: From SignUp to First Deployment

# How to Activate the 14-Day Free Trial on PipeOps  


__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

At PipeOps, we believe in making application deployment effortless for everyone, from solo developers to startups and enterprises. To help you experience everything our platform has to offer, we provide a 14-day free trial that unlocks the features you need to deploy, manage, and scale your applications.



## Step-by-Step: Activating Your 14-Day Free Trial
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

### Step 1:  Sign Up on PipeOps

Visit [pipeops.io](https://console.pipeops.io/auth/signup) to create an account. 


![PipeOps homepage](https://d23lxlhhocltbo.cloudfront.net/wp-content/uploads/2024/06/28014413/Screenshot-2024-06-27-223350.png)

There are different signup methods for your convenience:

- You can sign up using GitHub, Bitbucket, or GitLab.

-  You can also create an account by providing a vaild email address and strong password.
Verify your email by entering the one-time password (OTP) sent to your inbox.

<br>

![PipeOps homepage](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/otp-verification.png)



### Step 2: Customize your Workspace

The next step is to set up your workspace. Here, you'll be prompted to enter a name for your workspace. In PipeOps, a workspace helps you to organize and distinguish projects.


![Workspace name](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/choose-workspace-name.png)


After that, you'll need to provide answers to the following questions:

- What role best describes you

![Role](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/role-survey-question.png)


- The type of projects you plan to deploy

![Goal](https://d23lxlhhocltbo.cloudfront.net/wp-content/uploads/2024/06/28015249/2-2.png)


- How you discovered PipeOps

![Discover ](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/discovery-survey-question.png)


Click on "Finish" to complete.


### Step 3: Create a Server

The next page that appears requires you to choose a hosting method. You have two options when creating a new server: **On PipeOps** and **On Cloud Provider**.


![Choose path](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_on_pipeops_hosting_475e03e654.png)


For this guide, we'll go with the "On PipeOps" hosting method. 


### Step 4: Customize your Server

Choose your preferred provider, select the region you want to use, and click the "Proceed" button.

![Customize server](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_customize_server_3a0c84e1c7.png)


### Step 5: Select a Plan

Next, you'll see the different subscription plans available to you. The Growth Plan will have "**free trial - 14 days**" as shown below. 

![Select plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_select_plan_b871927ba5.png)

Click the **subscribe** button to activate your free trial. Keep in mind that this offer is only available to new users. 


### Step 6: Add a Payment Method

A confirmation modal appears after you select your plan. Choose a preferred payment method and click "Proceed to Subscribe."

![confirm plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_plan_confirm_3182ef5201.png)


### Access your Dashboard

Once your payment method is confirmed, you'll be taken to your PipeOps dashboard. You can now proceed to deploy applications to your newly-created server. 

![Access dashboard](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_server_fee7f7b276.png)


When you click the **Usage** tab, you'll see you're on the free Growth Plan. You can also view the duration of the free trial on this dashboard. 

![Usage dashboard](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/ft_usage_689ed40a5f.png)


## Conclusion  

Activating your 14-day free trial on PipeOps is seamless. In just a few clicks, you’ll unlock the full power of cloud deployment and automation. Ready to see how easy deployments can be? Sign up today and start building with confidence.

How to Activate the 14-day Free Trial on PipeOps

# How to Deploy Add-ons on PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________


This guide outlines the steps to deploy an add-on in PipeOps. The Add-ons section provides a variety of tools to enhance your projects. From databases to analytics tools, add-ons seamlessly extend your application's functionality.

## Deploying An Add-on

- To deploy an add-on, first log in to your [PipeOps dashboard](https://console.pipeops.io/auth/signup). 

- Click on the "**Addons**" option in the sidebar navigation menu on the left side of your screen. This takes you to the Add-ons marketplace.

![PipeOps Dashboard](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Dashboard_Overview_67745198c7.png)

![PipeOps Dashboard](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Add_ons_Marketplace_7568c3d9ad.png)

- Browse the available add-ons and choose the one you want to deploy.  For this guide, we’ll be deploying Adminer, a web-based database management tool.


- Click on the add-on to view its details. 

![PipeOps Adminer Page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Adminer_Details_Page_40b5adcc46.png)


## Review Add-on Details

On the add-on's details page, you'll find:

- A detailed description of the add-on's functionality.

- Information about the add-on's creator or provider.

- Any required dependencies.

Once you’ve confirmed it’s the correct add-on, click the "**Deploy App**" button to proceed to the configuration page.

![PipeOps Adminer Page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Pipe_Ops_Adminer_Deploy_Button_43be3e65cb.png)


## Configure Add-on

![Configure Adminer](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Add_on_Configuration_Page_cc1ee54c69.png)

On the configuration page, you can do the following:

- Select the server where you want to deploy your add-on

- Choose the environment (e.g., beta, development, or production) 

- View the resources required to deploy the add-on and the resources available to you

- Add additional add-ons to deploy alongside the current one

- Review and modify the current configuration settings

## Deploy Add-on

- Once you’ve fully configured the add-on, click the "**Deploy**" button to begin deployment. 

![Configure Adminer](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Add_on_Deployment_In_Progress_fbc5f6beb0.png)


- Upon successful deployment, a success modal will appear. Click the "**Got it**" button to proceed to the [Overview Page](https://docs.pipeops.io/docs/addons/addon-overview) of the add-on you just deployed. 




How to Deploy Add-ons on PipeOps

# Connecting Huawei to PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ 


## Overview

This documentation will guide you through the process of connecting your Huawei account to PipeOps. By following these steps, you’ll be able to create a Huawei server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.


## Steps to follow

To connect your Huawei account to PipeOps, follow these steps:

1. Ensure you have downloaded your Huawei credentials (a CSV file). If not, you can follow the guide [here](/docs/how-to-guides/tutorials/generate-huawei-credentials).

2. On the left menu, click on the "Integrations" tab.

![Cloud Integration Tab](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Cloud_Integration_Tab_51982c1895.png)

3. Click on the Huawei button among the list of cloud providers shown and click the "Connect" button.

![PipeOps Cloud Providers List](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Huawei_Connection_Screen_b775c1cf29.png)

4. An instruction screen appears, outlining the steps required to generate your Huawei credentials.
You can follow the guide [here](https://docs.pipeops.io/docs/how-to-guides/tutorials/generate-huawei-credentials) for a detailed walkthrough.

![Huawei Instruction Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Huawei_Instruction_Screen_f92cb23512.png)


5. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Huawei account. The optional field is useful in scenarios where you want to connect more than one Huawei account on PipeOps. Then provide your "Access Key" and "Secret Key" from the CSV file you downloaded. 


![PipeOps Huawei Credentials Input Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Huawei_Credentials_Upload_11a2f32896.png)

6. Click on the submit button at the bottom right. If the Huawei credentials are valid, your Huawei account will be successfully connected.


Now that you've connected your Huawei account to PipeOps, you can create a server on your connected Huawei account using this [guide](https://docs.pipeops.io/docs/servers/server-provisioning).



How to Connect Huawei to PipeOps

# Connecting GCP to PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ 


## Overview

This documentation will guide you through the process of connecting your GCP account to PipeOps. By following these steps, you’ll be able to create a GCP server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.


## Steps to follow

To connect your GCP account to PipeOps, follow these steps:

1. Ensure you have downloaded your GCP JSON credentials. If not, you can follow the guide [here](https://docs.pipeops.io/docs/how-to-guides/tutorials/generate-gcp-json-credentials).

2. On the left menu, click on the "Integrations" tab.

![Cloud Integration Tab](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Cloud_Integration_Tab_51982c1895.png)


3. Select "Google Cloud Platform" from the list of cloud providers shown and click the "Connect" button.

![PipeOps Cloud Providers List](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/GCP_Connection_Screen_610ba6b373.png)

4. An instruction screen appears, outlining the steps required to generate your GCP credentials.
You can follow this guide [here](https://docs.pipeops.io/docs/how-to-guides/tutorials/generate-gcp-json-credentials) for a detailed walkthrough.

![GCP Instruction Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/GCP_Instruction_Screen_a531f5f73d.png)

5. On the "Upload Credentials JSON" screen, you can provide an optional name to identify your uploaded GCP JSON credentials. The optional field is useful in scenarios where you want to connect more than one GCP account on PipeOps.

![GCP JSON Credentials Upload Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/GCP_JSON_Credentials_Upload_2ee21ee514.png)

6. Click on the submit button at the bottom right. If the JSON credentials are valid, your GCP account will be successfully connected.



Now that you've connected your GCP account to PipeOps, you can create a server on your connected GCP account using this [guide](https://docs.pipeops.io/docs/servers/server-provisioning).



How to Connect GCP to PipeOps

# Connecting Digital Ocean to PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ 

## Overview

This documentation will guide you through the process of connecting your Digital Ocean account to PipeOps. By following these steps, you’ll be able to create a Digital Ocean server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.

## Steps to follow

To connect your Digital Ocean account to PipeOps, follow these steps:

1. In the PipeOps Dashboard, click on the "Integrations" tab from the left menu.

![Cloud Integration Tab](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Cloud_Integration_Tab_51982c1895.png)

2. Select "Digital Ocean" from the list of cloud providers and click "Connect" to proceed. 

![DO Connection Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/DO_Connection_Screen_bf950aba66.png)

3. On the **Authorize DigitalOcean** screen, click the "Authorize my Digital Ocean" button. This will open a new tab to the right.

![DO Authorization Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/DO_Authorization_Screen_87b3dc76a8.png)

4. You will be redirected to DigitalOcean’s authorization page, as shown below. Click the "**Authorize Authorization**" button to grant PipeOps the necessary permissions.

![Authorize PipeOps on DO](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Authorize_Pipe_Ops_on_DO_Tab_d06ee3371f.png)

5. After authorization, you will be redirected back to PipeOps. If successful, you'll see DigitalOcean listed as a connected provider.

![Successful DO Integration](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Successful_DO_Integration_137892265a.png)

Now that you've connected your Digital Ocean account to PipeOps, you can create a server on your connected account using this [guide](https://docs.pipeops.io/docs/servers/server-provisioning).

How to Connect Digital Ocean to PipeOps

# Connecting Azure to PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ 



## Overview

This documentation will guide you through the process of connecting your Azure account to PipeOps. By following these steps, you’ll be able to create an Azure server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.


## Steps to follow

To connect your Azure account to PipeOps, follow these steps:

1. Ensure you have your Azure credentials. If not, you can follow the guide [here](https://docs.pipeops.io/docs/how-to-guides/tutorials/generate-azure-credentials).

2. On the left menu, click on the "Integrations" tab.


![Cloud Integration Tab](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Cloud_Integration_Tab_51982c1895.png)


3. Select "Azure" from the list of cloud providers and click the "Connect" button.

![Azure Connection Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Azure_Connection_Screen_8ee52cad10.png)

4. An instruction screen appears, outlining the steps required to create your Azure credentials.
You can follow this guide [here](https://docs.pipeops.io/docs/how-to-guides/tutorials/generate-azure-credentials) for a detailed walkthrough.

![Azure Instruction Screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Azure_Instruction_Tab_d16cefcb3a.png)

5. On the "Enter Access Credentials" screen, you can provide an optional name to identify your Azure account. The optional field is useful in scenarios where you want to connect more than one Azure account on PipeOps.

![Azure Instruction Screen Filled](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Azure_Connection_Screen_Filled_b59ab96305.png)

Fill in the required fields with your credentials:

- Resource Group Name
- Tenant ID
- Client ID
- Client Secret
- Subscription ID

6. Click the submit button. If the credentials are correct, PipeOps will successfully integrate with Azure.

![Successful Azure Connection](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Successful_Azure_Integration_1221c9e8ba.png)

Now that you've connected your Azure account to PipeOps, you can create a server on your connected Azure account using this [guide](https://docs.pipeops.io/docs/servers/server-provisioning).

How to Connect Azure to PipeOps

# Connecting AWS to PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________ 


## Overview

This documentation will guide you through the process of connecting your AWS account to PipeOps. By following these steps, you’ll be able to create an AWS server on PipeOps and deploy projects on the server directly from your PipeOps dashboard.

## Steps to follow

To connect your AWS account to PipeOps, follow these steps:

1. On the left menu, click on the "Integrations" tab.

![Cloud Integration Tab](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Cloud_Integration_Tab_51982c1895.png)

2. Select AWS from the list of cloud providers shown and click the "Connect" button.

![PipeOps Cloud Providers List](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Cloud_Provider_List_ff348bfbe8.png)

3. On the "Connect AWS" screen, you can provide an optional name to identify your AWS account. The optional field is useful in scenarios where you want to connect more than one AWS account on PipeOps.

![AWS Connection screen](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/AWS_Connection_Screen_175273010d.png)

4. Fill in your AWS Account ID found at the top-right corner of your AWS account and an optional name.

![AWS Connection screen filled](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/AWS_Connection_Screen_Filled_6dbfafcb65.png)

5. After filling out the form, click on the "Add" button. A spinner loads, enabling the "Authorize IAM" button.

6. Click on the "Authorize IAM" button. It should open a "Create Stacks" page in a new tab in your AWS account, which will prompt you to acknowledge "that AWS CloudFormation might create IAM resources with customised names" on the bottom of the page. 

Click on the "Create stack" button at the bottom right of the page.

![AWS Create Cloud Formation Stacks Page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/AWS_Cloud_Formation_Page_65d73f635d.png)

7. After clicking the "Create stack" button. You will have a page similar to this.

![ AWS Create Cloud Formation Stack In Progess Page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/AWS_Cloud_Formation_Stack_in_Progress_e96537f489.png)

8. You can switch back to your PipeOps tab to the left and wait for a few seconds and your AWS account will automatically get connected.

![Successful AWS Integration Page](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Successful_AWS_Integration_f69a665941.png)

Now that you've connected your AWS account to PipeOps, you can create a server on your connected AWS account using this [guide](https://docs.pipeops.io/docs/servers/server-provisioning).



How to Connect AWS to PipeOps

# Creating Affordable Servers On PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________


In this section, we'll guide you through setting up your PipeOps account using one of PipeOps' own servers. Follow these steps to configure your server and seamlessly deploy your applications.



### Step 1: Choose PipeOps Hosting Option

Whether you're continuing your account setup or adding an extra server, the following steps apply to both scenarios.

- You will be prompted to choose where you want to create your server.

- Select "**On PipeOps**" as your server creation method.


![Choose path](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/Deploy_On_Pipeops_be984335cd.png)


### Step 2: Customize Your Server

You'll then be directed to:

- **Choose a preferred provider:** Digital Ocean, Google Cloud, Amazon Web Services, Azure, or Huawei Cloud.

- **Select region:** Pick the geographic location for deploying your server. We've implemented a geo-location pricing model to ensure you're billed in your local currency, protecting you from exchange rate fluctuations.

- **Review the monthly cost:** You can adjust resources such as CPU, memory, and storage to estimate your monthly cost. 

![Customize your server](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/69/Customize_Server_11b881114d.png)


Use the sliders to adjust the following:

  - **CPU:** The number of virtual CPUs for your server. This determines the processing power available for running your applications.

  - **Memory:** This specifies the amount of RAM to allocate to your server. Sufficient memory is crucial for smooth operation, especially when running multiple applications or handling large datasets.

  - **Storage:** The storage capacity for your server, including the operating system and data.

**Note:** This is an estimate to help you gauge costs. Your final charge will depend on your actual resource usage.

### Step 3: Select a Plan

After customizing your server, the next step is to choose a subscription that best fits your needs. PipeOps offers three pricing plans: **Growth, Scale,** and **Custom**, with monthly or yearly billing options.

![Select a plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/69/Select_Plan_af44e71508.png)
 
To learn more about each plan, its features, and billing methods, check out our [pricing section](https://pipeops.io/pricing).


### Step 4: Select Payment Method

After choosing your preferred plan, a confirmation modal appears. Review your subscription plan and select a payment method to finalize your setup. You can select from popular payment methods, including Stripe and Paystack. 


![Confirm plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/69/Plan_Confirmation_d5196aa50a.png)

After selecting a payment method, you’ll be redirected to a secure checkout page.


### Step 5: Access Your Dashboard
Once your payment is confirmed, you will receive a pop-up notification. Your dashboard will then be available, allowing you to deploy applications to your newly created server.

![Server Overview](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/26/Overview_027a244c0c.png)


### Step 6: Proceed to Project Deployment

You can now proceed to deploy applications into your server. 
See the [project deployment guide](https://docs.pipeops.io/docs/projects/project-deployment) for a comprehensive guide to getting your applications up and running with PipeOps.



Creating Servers on PipeOps

large_Deploy_On_Pipeops_be984335cd.png

medium_Deploy_On_Pipeops_be984335cd.png

small_Deploy_On_Pipeops_be984335cd.png

thumbnail_Deploy_On_Pipeops_be984335cd.png

Deploy_On_Pipeops_be984335cd.png

# How to Create a Cloud Server on PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

PipeOps supports **Bring Your Own Cloud (BYOC)** deployment model, allowing you to integrate your existing cloud accounts while leveraging PipeOps' features. 

This section walks you through provisioning a server on your preferred cloud provider via the PipeOps dashboard.  


### Step 1: Choose Cloud Hosting Option

Whether you are continuing your account creation process or just trying to deploy an additional server, the following guide still applies to both cases. 

-  You will be prompted to choose where you want to create your server.

-  Select "**On Cloud Provider**" as your server creation method.

![Choose path](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/Deploy_On_Cloud_d5e1edc1a2.png)  


### Step 2: Choose Your Preferred Cloud Provider

You can provision a server on different cloud providers, including:

- Amazon Web Services (AWS)
- Azure
- Digital Ocean
- Google Cloud
- Huawei Cloud

![Choose provider](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Choose_Cloud_Provider_50fd9682a5.png)  

Choose your preferred provider from the list. Click **Connect** and follow the on-screen instructions to link your cloud account with PipeOps.

Check out the [Integrations](https://docs.pipeops.io/docs/category/integrations/) section for details on how to link your account.

### Step 3: Select a Plan

The next step is to choose a subscription that best fits your needs. PipeOps offers three pricing plans: **Growth, Scale,** and **Custom**. You can choose monthly or yearly billing.

![Select a plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/69/Select_Plan_af44e71508.png)

To learn more about each plan, its features, and billing methods, check out our [pricing section](https://pipeops.io/pricing).


### Step 4: Select Payment Method

After choosing your preferred plan, a confirmation modal appears. Review your subscription plan and select a payment method to finalize your setup. You can select from popular payment methods, including Stripe and Paystack. 


![Confirm plan](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/69/Plan_Confirmation_d5196aa50a.png)

After selecting a payment method, you’ll be redirected to a secure checkout page.


### Step 5: Server Creation
Once the payment is successful, you will be redirected to your dashboard. Click the **Proceed** button to start setting up your server. 

To set up your cloud server:  
1. Select your preferred region and click **Next**.

![Select region](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Select_Region_acf49a4d9a.png)

2. Choose a configuration method: 

![Choose configuration method](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Choose_Configuration_Method_a5844f41e9.png)

- Select **custom configuration** to manually set up CPU, storage, and memory.

- Otherwise, select **Karpenter** for automatic scaling. 

### Step 6: Configure Resources
The next step is to customize your server resources. The options available on this page depend on your chosen configuration method.

**Custom Configuration:** Choose a deployment environment (Dev, Staging, or Production) and an instance category (General Purpose, Compute Optimized, or Memory Optimized).

![Configure custom resources](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Configure_Custom_Resources_c80f792a79.png)

**Karpenter Configuration:** Choose a preferred node architecture or proceed with default settings. You can also enable Spot instances to use cheaper cloud services.

![Configure karpenter resources](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Configure_Karpenter_Resources_dcd846ecc9.png)

Once configured, click the **Create Server** button to proceed. A modal will appear showing server creation progress in real time.

### Step 7: Proceed to Project Deployment

Once your server creation is complete, you’ll see a modal indicating that. You can now deploy applications to the newly created server.
See the [Project Deployment Guide](https://docs.pipeops.io/docs/projects/project-deployment) for a comprehensive guide to getting your applications up and running with PipeOps.


How to Create a Cloud Server on PipeOps

# Deployment Path Guide
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

## Choosing a deployment path

You can choose between deploying to PipeOps's servers or your preferred cloud provider (AWS, Azure, GCP, Digital Ocean) for seamless deployment tailored to your needs.


&nbsp;

## Step 1: On PipeOps

In this section, we'll guide you through setting up one of PipeOps' own servers. Follow these steps: [On PipeOps](https://docs.pipeops.io/docs/getting-started/deployment-path/on-pipeops).
\
&nbsp;

![PipeOps homepage](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/Deploy_On_Pipeops_be984335cd.png)

\
&nbsp;

## Step 2: On Cloud Provider

In this section, we will show how you can set up your PipeOps account using your cloud Provider. Follow these steps to set up your account and seamlessly deploy applications on your preferred cloud provider. [On Cloud Provider](https://docs.pipeops.io/docs/getting-started/choose-your-deployment-path/on-cloud-provider).

\
&nbsp;

![PipeOps homepage](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/Deploy_On_Cloud_d5e1edc1a2.png)

\
&nbsp;


For any additional questions or support, please contact us at [Support Contact](mailto:support@pipeops.io)

Deployment Path On PipeOps

# User Registration Guide
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

## Getting Started with PipeOps Registration

Welcome to PipeOps! In this guide, we'll walk you through the simple and seamless registration process to get you started with our powerful deployment solutions.

\
&nbsp;

## Step 1: Visit the Home Page

Open your preferred web browser and navigate to the pipeops homepage. You can use the direct URL: [https://pipeops.io](https://pipeops.io).
\
&nbsp;

![PipeOps homepage](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/homepage_d3d284d5fd.png)

\
&nbsp;

## Step 2: Visit the Registration Page

To begin the registration process, click on the 'Deploy app' or 'Deploy a free app' button on the top right corner, or the middle of your screen. This would redirect you to the pipeops signin console. Click on the 'Create a new account here' link, and begin your registration. Or use the direct URL: [https://console.pipeops.io/auth/signup](https://console.pipeops.io/auth/signup).

\
&nbsp;

![PipeOps homepage](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/homepage1_331e37d64b.png)

\
&nbsp;

## Step 3: Sign In Options

In the 'Create an account' sign up box, you have 4 options to sign up.

- Sign up using your existing GitHub account.

- Sign up using your existing GitLab account.

- Sign up using your existing BitBucket account.

- Sign up using an email account.

In the first 3 options, you will need to enter your credentials to allow pipeops connect with your account. You also will not need to connect to that repository provider later if you already chose it as your sign up method.

\
&nbsp;

![PipeOps homepage](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/signin_b8cfb0bcd8.png)

\
&nbsp;

## Step 4: Provide Your Email Address

On the registration page, for the email option, you'll be prompted to enter your email address. This will be your primary contact for important updates and notifications related to your account. Please make sure to use a valid and accessible email address.

\
&nbsp;

## Step 5: Set a Strong Password

Create a secure password for your account. A strong password typically includes a combination of uppercase and lowercase letters, numbers, and special characters. This ensures the safety and integrity of your account. Click on 'Proceed'.

\
&nbsp;

## Step 6: Verify Your Email Address

After submitting the registration form, you will be redirected to a page requesting for your registration OTP. Check your email inbox for a verification message containing the token, paste into the box and proceed.

\
&nbsp;

![PipeOps homepage](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/otp_a12ad0250c.png)

\
&nbsp;

## Step 7: Customize Your Workspace

Before completing the registration, we want to tailor your experience with PipeOps to suit your needs. You would answer the following questions to configure your workspace:

1. **Workspace Name:**

   - This section prompts you to choose a name for your workspace. The workspace name helps you organize and distinguish your projects within PipeOps.

\
&nbsp;

![Workspace name](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/workspace_76e1748c31.png)

\
&nbsp;

2. **Your role/Job Title:**

   - Here, you can specify your role or job title, which provides context for your usage of PipeOps. Whether you're a software developer, founder, or DevOps engineer, identifying your role will help us serve you better.

\
&nbsp;

![Role](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/role_e2a25cc747.png)

\
&nbsp;

3. **Goal with PipeOps:**

   - This section helps clarify your objectives for using PipeOps. You can select from options such as exploring PipeOps features for companies or deploying a simple project to the cloud. Understanding your goals allows us to provide relevant guidance and support.

\
&nbsp;

![Goal](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/needs_c09f9b7a53.png)

\
&nbsp;

4. **Discovering PipeOps:**
    
   - This section inquires about how you found out about PipeOps. Whether through Linkedin, a goole search, or another avenue, knowing how users discover PipeOps helps us improve and reach more people.

\
&nbsp;

![Discover ](https://pub-30c11acc143348fcae20835653c5514d.r2.dev//20/25/discover_419f076830.png)

\
&nbsp;

Once you've answered these questions, your workspace will be configured accordingly, providing a personalized experience tailored to your specific requirements.

\
&nbsp;

## Step 8: Complete Registration

After customizing your workspace, you're now ready to complete the registration process. Review the information you've provided, make any necessary adjustments, and click the "Finish" button.

You are now set to proceed with deploying your server either on PipeOps or a cloud provider. Head to the [***Deployment Path***](https://docs.pipeops.io/docs/category/deployment-path) section for guidance.


User Registration Guide

large_s7.png

medium_s7.png

small_s7.png

thumbnail_s7.png

s7.png

Welcome to the streamlined integration of PipeOps with GitHub. This guide will walk you through the steps to authenticate PipeOps with your GitHub account, ensuring a seamless connection for enhanced collaboration for efficient cloud deployments.

Let's simplify your development process


## Prerequisites:
Begin by creating your [GitHub Account](https://github.com/), if you haven't already



## How to Configure Your GitHub Public Email  


Configure your GitHub public email for a seamless authentication process. This step is essential for the authentication process and account creation. PipeOps uses this email to create your account for future authentication.

GitHub typically sets the email to private by default, but it's essential to adjust this setting to ensure a smooth and successful integration with PipeOps. By making your email public, you facilitate a more transparent and efficient collaboration between both platforms.

Now let's follow the steps below to ensure your GitHub email is set to public, allowing PipeOps to authenticate and create your account seamlessly.



## First Step

-  The first step is to navigate to your settings


 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s1_2e5b2504a4.png)
 


- Select the **emails** under the Access button


 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s2_a9c6b8c047.png) 



- Scroll down and uncheck the *keep my email addresses private* to inactive. This will allow your verified email(s) to be Public.



 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s3_4097b293d4.png) 


## Second step:

- Next, Navigate to the **public profile**, still in the settings.
- On the Public Profile page, Select the verified email from the Public Email field list(s)


 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s4_fc7030a2fb.png) 



- Click on the update button below to update the changes.

- Allow some minutes for GitHub to sync this change to your settings.

*You have successfully updated your public email. Next let's authenticate with PipeOps*



## Authentication from PipeOps   


Before authenticating with GitHub from the PipeOps Dashboard, let's confirm the following checkpoints below, you can refer to the above steps on how to configure them.


 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s5_dcc948088d.png) 

- Active GitHub account

- GitHub Public Email Configured.



Once the above checkpoints are met, Authentication with PipeOps is a straightforward next step.

- Simply navigate to the PipeOps dashboard, where you'll find intuitive options to link different version control providers, in this case, we are using the GitHub option.

- Follow the prompts to connect securely with PipeOps and your GitHub account.


 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s6_db80472c33.png) 


This user-friendly authentication process ensures you can quickly integrate PipeOps into your workflow, making cloud management a smooth and efficient experience.

- On successful authentication, you are automatically redirected to your project dashboard.



 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s7_046ab43f32.png) 




*You have successfully authenticated your GitHub with PipeOps*



## How to Grant PipeOps Access to Private Repositories  


    
After integrating your GitHub account with PipeOps, only public repositories are accessible by default. Follow these steps to grant PipeOps access to your private repositories:

- Navigate to your Project dashboard and select GitHub as your repository provider.

-  Click on **Install PipeOps Git**

![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Install_Pipe_Ops_Git_9e293884ea.png)


-  A modal will appear, outlining what installing the PipeOps Git App will do. 

![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Install_Pipe_Ops_Git_Modal_e183fd7e64.png)

-  Click the **Install PipeOps Git** button at the bottom of the modal. This will redirect you to an authorization page as shown below. 

![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/20/69/Git_Hub_Authorization_Page_5c654a3bab.png)

- On this page, you can specify the scope of repository access:

   - All Repositories: Select this option to grant PipeOps access to both public and private repositories.
    
   - Only Select Repositories: Choose this option to grant access to specific repositories.

 

- Click on the **Install and Authorize** button to proceed. You'll be redirected to the PipeOps project dashboard. 

Now, when you select your GitHub profile, you'll be able to view both your private and public repositories.


## How to remove PipeOps Authorization from a GitHub Account.  


Maintain control and security by easily revoking PipeOps authorization from your GitHub account when needed. Should the necessity arise,

- Navigate to your GitHub account settings, specifically the **Authorized OAuth apps** section.

- Here, you'll find a list of connected applications, including PipeOps. 
Select PipeOps from the list and follow the prompts to revoke its authorization or you can **revoke all** to remove access to all your applications.


 ![](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/s8_963dd882e2.png) 



This simple yet crucial step ensures that you have full control over the access granted to PipeOps, allowing you to manage your GitHub integrations securely and in alignment with your preferences.

How to Authenticate with PipeOps Using  GitHub

large_LINK THUMBNAIL.png

medium_LINK THUMBNAIL.png

small_LINK THUMBNAIL.png

thumbnail_LINK THUMBNAIL.png

LINK THUMBNAIL.png

## Django On PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

PipeOps is the ideal platform for deploying your Django applications due to its robust support. As you read on, you'll discover just how effortless it is to deploy your project.

\
&nbsp;
\
&nbsp;



## Getting Started
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

For a quick and hassle-free start, you can clone our pre-built Django template from here. This template comes with a Dockerfile that will be used during deployment. However, if you already have a project to deploy, you'll need to create a Dockerfile and copy the relevant information from our Django template Dockerfile into your project's Dockerfile.

\
&nbsp;

Here's an example Dockerfile based on our Django template:

\
&nbsp;
\
&nbsp;


```
# Set the base image to Python 3.9
FROM python:3.11.0

# Set environment variables
ENV PYTHONUNBUFFERED 1
ENV PYTHONDONTWRITEBYTECODE 1

# Set the working directory to /app
WORKDIR /app

# Copy the requirements file into the container and install dependencies
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

# Copy the application code into the container
COPY . .

# Run database migrations
RUN python manage.py migrate

# Expose port 8000 for the Django application
EXPOSE 8000

# Start the Django development server
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
```

\
&nbsp;
\
&nbsp;



## Deploy Your Project
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

We assume that you've gone through our get started guide. If not, you can access it here. Once you've gone through the guide, you can proceed to connect your PipeOps account to your preferred git provider and select your project. In the image below, you'll find the necessary configurations for your Django project. After completing these configurations, you can click on the "Deploy Project" button to deploy your project.

\
&nbsp;
\
&nbsp;

![nodejs.webp](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/nodejs_5d30a33b7f.webp)

\
&nbsp;
\
&nbsp;


👍 Awesome!, You have now deployed your Django project.

\
&nbsp;

![image_5_bhabno.png](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/image_5_bhabno_649203b253.png)

Django On PipeOps

## PipeOps Deployment Support

The table below contains a comprehensive list of Pipeops-compatible frameworks, including their compatible build methods for deployment and corresponding run commands.

\
&nbsp;

| Frameworks    | Build Method                        | Run Command                           |
| :------------ | :--------------------------------- | ------------------------------------ |
| Django        | Paketo, Heroku, Dockerfile          | `python manage.py runserver`          |
| Ruby on Rails | Dockerfile, Heroku, Paketo          | `bin/rails server`                    |
| Flask         | Paketo, Heroku, Dockerfile          | `python {{the file}}`                 |
| Express       | Dockerfile, Heroku, Paketo, Node    | `node {{the file}}`                   |
| React         | Paketo, Heroku, Dockerfile, Node    | `npm dev`, `yarn dev`, `pnpm dev`     |
| Angular       | Dockerfile, Heroku, Paketo, Node    | `ng serve`                            |
| Laravel       | Paketo, Heroku, Dockerfile          | `php artisan serve`                   |
| Spring        | Dockerfile, Heroku, Paketo          | `java -jar target/{{project-name}}.jar`|
| ASP.NET       | Paketo, Heroku, Dockerfile          | `dotnet watch`                        |
| Vue.js        | Dockerfile, Heroku, Paketo, Node    | `npm dev`, `yarn dev`, `pnpm dev`     |
| FastAPI       | Paketo, Heroku, Dockerfile          | `python {{the file}}`                 |
| Gin           | Dockerfile, Heroku, Paketo          | `go run {{the file}}`                 |
| Fiber         | Dockerfile, Heroku, Paketo          | `go run {{the file}}`                 |
| Next.js       | Paketo, Heroku, Dockerfile, Node    | `npm dev`, `yarn dev`, `pnpm dev`     |
| Nuxt.js       | Dockerfile, Heroku, Paketo, Node    | `npm dev`, `yarn dev`, `pnpm dev`     |
| Nest.js          | Paketo, Heroku, Dockerfile, Node    | `npm run start`                       |
| Solid.js      | Dockerfile, Heroku, Paketo, Node    | `npm run dev`                         |

PipeOps Deployment Support

## Rust On PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

PipeOps is the ideal platform for deploying your Rust applications due to its robust support. As you read on, you'll discover just how effortless it is to deploy your project.

\
&nbsp;
\
&nbsp;



## Getting Started
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

For a quick and hassle-free start, you can clone our pre-built Rust template from here. This template comes with a Dockerfile that will be used during deployment. However, if you already have a project to deploy, you'll need to create a Dockerfile and copy the relevant information from our Rust template Dockerfile into your project's Dockerfile.

\
&nbsp;

Here's an example Dockerfile based on our Rust template:

\
&nbsp;
\
&nbsp;


```

# Use a Rust base image
FROM rust:latest as build

# Set the working directory in the container
WORKDIR /app

# Copy the Cargo.toml and Cargo.lock files to the container
COPY Cargo.toml ./

# Create an empty project with the same dependencies to cache them
RUN mkdir src && \
    echo "fn main() {println!(\"if you see this, the build broke\")}" > src/main.rs && \
    cargo build --release && \
    rm -f target/release/deps/pipeops-rust*

# Copy the rest of the source code to the container
COPY . .

# Build the Rust application
RUN cargo build --release

# Create a smaller final image
FROM debian:buster-slim

# Set the working directory in the final image
WORKDIR /app

# Copy the built application from the build image to the final image
COPY --from=build /app/target/release/pipeops-rust .

# Expose the port your Rust web application listens on (change as needed)
EXPOSE 8000

# Command to run your Rust web application (adjust as needed)
CMD ["./pipeops-rust"]


```

\
&nbsp;
\
&nbsp;



## Deploy Your Project
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

We assume that you've gone through our get started guide. If not, you can access it here. Once you've gone through the guide, you can proceed to connect your PipeOps account to your preferred git provider and select your project. In the image below, you'll find the necessary configurations for your Rust project. After completing these configurations, you can click on the "Deploy Project" button to deploy your project. 

\
&nbsp;

![nodejs.webp](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/nodejs_5d30a33b7f.webp)


\
&nbsp;



👍 Awesome!, You have now deployed your Rust project.


\
&nbsp;

![image_5_bhabno.png](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/image_5_bhabno_649203b253.png)



Rust On PipeOps

## PHP On PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

PipeOps is the ideal platform for deploying your PHP applications due to its robust support. As you read on, you'll discover just how effortless it is to deploy your project.

\
&nbsp;
\
&nbsp;



## Getting Started
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

For a quick and hassle-free start, you can clone our pre-built PHP template from here. This template comes with a Dockerfile that will be used during deployment. However, if you already have a project to deploy, you'll need to create a Dockerfile and copy the relevant information from our PHP template Dockerfile into your project's Dockerfile.

\
&nbsp;

Here's an example Dockerfile based on our PHP template:

\
&nbsp;
\
&nbsp;


```
# Use an official PHP runtime as the base image
FROM php:7.4-apache
FROM php:7.4-apache
# Set the working directory in the container
WORKDIR /var/www/html
# Copy the application code to the container
COPY . /var/www/html
# Install any necessary PHP extensions or dependencies
RUN apt-get update && \
    apt-get install -y \
        # Add any additional dependencies here
    && rm -rf /var/lib/apt/lists/* \
    && docker-php-ext-install mysqli pdo pdo_mysql \
    && a2enmod rewrite
# Expose port 80 for the Apache web server
EXPOSE 80
# Define environment variables if needed
# ENV MY_ENV_VAR=value
# Start the Apache web server
CMD ["apache2-foreground"]
```

\
&nbsp;
\
&nbsp;



## Deploy Your Project
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

We assume that you've gone through our get started guide. If not, you can access it here. Once you've gone through the guide, you can proceed to connect your PipeOps account to your preferred git provider and select your project. In the image below, you'll find the necessary configurations for your PHP project. After completing these configurations, you can click on the "Deploy Project" button to deploy your project.

\
&nbsp;
\
&nbsp;

![nodejs.webp](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/nodejs_5d30a33b7f.webp)

\
&nbsp;
\
&nbsp;


👍 Awesome!, You have now deployed your PHP project.

\
&nbsp;

![image_5_bhabno.png](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/image_5_bhabno_649203b253.png)

PHP On PipeOps

## Node.js On PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

PipeOps is the ideal platform for deploying your Node.js applications due to its robust support. As you read on, you'll discover just how effortless it is to deploy your project.

\
&nbsp;
\
&nbsp;



## Getting Started
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

For a quick and hassle-free start, you can clone our pre-built Node.js template from here. This template comes with a Dockerfile that will be used during deployment. However, if you already have a project to deploy, you'll need to create a Dockerfile and copy the relevant information from our Node.js template Dockerfile into your project's Dockerfile.

\
&nbsp;

Here's an example Dockerfile based on our Node.js template:

\
&nbsp;
\
&nbsp;


```

FROM node:18

# Create app directory
WORKDIR /usr/src/app

# Install app dependencies
# A wildcard is used to ensure both package.json AND package-lock.json are copied
# where available (npm@5+)
COPY package*.json ./

RUN npm install
# If you are building your code for production
# RUN npm ci --omit=dev

# Bundle app source
COPY . .

EXPOSE 8080
CMD [ "node", "server.js" ]

```

\
&nbsp;
\
&nbsp;



## Deploy Your Project
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

We assume that you've gone through our get started guide. If not, you can access it here. Once you've gone through the guide, you can proceed to connect your PipeOps account to your preferred git provider and select your project. In the image below, you'll find the necessary configurations for your Node.js project. After completing these configurations, you can click on the "Deploy Project" button to deploy your project. 

\
&nbsp;

![nodejs.webp](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/nodejs_5d30a33b7f.webp)


\
&nbsp;



👍 Awesome!, You have now deployed your NodeJS project.


\
&nbsp;

![image_5_bhabno.png](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/image_5_bhabno_649203b253.png)



Node.js On PipeOps

## Flask On PipeOps
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________
\
&nbsp;

PipeOps is the ideal platform for deploying your Flask applications due to its robust support. As you read on, you'll discover just how effortless it is to deploy your project.

\
&nbsp;
\
&nbsp;



## Getting Started
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

For a quick and hassle-free start, you can clone our pre-built Flask template from [here](https://github.com/pipeops-dev/pipeops-flask). This template comes with a Dockerfile that will be used during deployment. However, if you already have a project to deploy, you'll need to create a Dockerfile and copy the relevant information from our Flask template Dockerfile into your project's Dockerfile.

\
&nbsp;

Here's an example Dockerfile based on our Flask template:

\
&nbsp;
\
&nbsp;


```

# Set the base image to Python 3.9
FROM python:3.11.0

# Set environment variables
ENV PYTHONUNBUFFERED 1
ENV PYTHONDONTWRITEBYTECODE 1

# Set the working directory to /app
WORKDIR /app

# Copy the requirements file into the container and install dependencies
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

# Copy the application code into the container
COPY . .

# Expose port 5000 for the Flask application
EXPOSE 5000

# Start the Flask development server
CMD ["python", "manage.py", "0.0.0.0:5000"]

```

\
&nbsp;
\
&nbsp;



## Deploy Your Project
__________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________________

\
&nbsp;

We assume that you've gone through our get started guide. If not, you can access it [here](https://docs.pipeops.io/developers). Once you've gone through the guide, you can proceed to connect your PipeOps account to your preferred git provider and select your project. In the image below, you'll find the necessary configurations for your Flask project. After completing these configurations, you can click on the "Deploy Project" button to deploy your project.

\
&nbsp;

![nodejs.webp](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/nodejs_5d30a33b7f.webp)


\
&nbsp;



👍 Awesome!, You have now deployed your Flask project.


\
&nbsp;

![image_5_bhabno.png](https://pub-30c11acc143348fcae20835653c5514d.r2.dev/image_5_bhabno_649203b253.png)



Guides