# Build from source code

## Prerequisites 

To build Percona Backup for MongoDB from source, you need the following:

* Go 1.19 or above. [Install and set up Go tools :octicons-link-external-16:](https://golang.org/doc/install)
* make
* git
* `krb5-devel` for Red Hat Enterprise Linux / CentOS or `libkrb5-dev` for Debian / Ubuntu. This package is required for Kerberos authentication in Percona Server for MongoDB.

## Procedure

Here's how to build Percona Backup for MongoDB:
{.power-number}

1. Clone the repository

    ```{.bash data-prompt="$"}
    $ git clone https://github.com/percona/percona-backup-mongodb
    ```

2. Go to the project directory and build it

    ```{.bash data-prompt="$"}
    $ cd percona-backup-mongodb
    $ make build
    ```

After **make** completes, you can find `pbm` and `pbm-agent` binaries
in the `./bin` directory. 

3. Check that Percona Backup for MongoDB has been built correctly and is ready for use. 

    ```{.bash data-prompt="$"}
    $ cd bin
    $ ./pbm version
    ```

    ??? example "Output"    

    ```{.text .no-copy}
    Version:   [pbm version number]
    Platform:  linux/amd64
    GitCommit: [commit hash]
    GitBranch: main
    BuildTime: [time when this version was produced in UTC format]
    GoVersion: [Go version number]
    ```

    !!! tip    

        Instead of specifying the path to pbm binaries, you can add it to the PATH environment variable:    

        ```{.bash data-prompt="$"}
        $ export PATH=/percona-backup-mongodb/bin:$PATH
        ```

## Post-install steps

=== ":material-debian: On Debian and Ubuntu"
    
    After the installation, do the following:
    {.power-number}

     1. Create the environment file:

         ```{.bash data-prompt="$"}
         $ touch /etc/default/pbm-agent
         ```

     2. Create the `pbm-agent.service` systemd unit file.

         ```{.bash data-prompt="$"}
         $ sudo vim /lib/systemd/system/pbm-agent.service
         ```

     3. In the `pbm-agent.service` file, specify the following:

         ```init
         [Unit]
         Description=pbm-agent
         After=time-sync.target network.target

         [Service]
         EnvironmentFile=-/etc/default/pbm-agent
         Type=simple
         User=mongod
         Group=mongod
         PermissionsStartOnly=true
         ExecStart=/usr/bin/pbm-agent

         [Install]
         WantedBy=multi-user.target
         ```
         
        !!! note

            Make sure that the `ExecStart` directory includes the Percona Backup for MongoDB binaries. Otherwise, copy them from the `./bin` directory of you installation path.

     4. Make `systemd` aware of the new service:

         ```{.bash data-prompt="$"}
         $ sudo systemctl daemon-reload
         ```

=== ":material-redhat: On Red Hat Enterprise Linux and derivatives"

    After the installation, do the following:
    {.power-number}

    1. Create the environment file:
   
        ```{.bash data-prompt="$"}
        $ touch /etc/sysconfig/pbm-agent
        ```

    2. Create the `pbm-agent.service` systemd unit file.

        ```{.bash data-prompt="$"}
        $ sudo vim /usr/lib/systemd/system/pbm-agent.service
        ```

    3. In the `pbm-agent.service` file, specify the following:

         ```init
         [Unit]
         Description=pbm-agent
         After=time-sync.target network.target

         [Service]
         EnvironmentFile=-/etc/default/pbm-agent
         Type=simple
         User=mongod
         Group=mongod
         PermissionsStartOnly=true
         ExecStart=/usr/bin/pbm-agent

         [Install]
         WantedBy=multi-user.target
         ```
         
        !!! note

            Make sure that the `ExecStart` directory includes the Percona Backup for MongoDB binaries. Otherwise, copy them from the `./bin` directory of you installation path.

     4. Make `systemd` aware of the new service:

         ```{.bash data-prompt="$"}
         $ sudo systemctl daemon-reload
         ```

## Next steps

[Initial setup :material-arrow-right:](initial-setup.md){.md-button}