{"id":627,"date":"2021-07-23T12:34:18","date_gmt":"2021-07-23T12:34:18","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/guide-to-git-for-system-administrators\/"},"modified":"2021-07-23T12:34:18","modified_gmt":"2021-07-23T12:34:18","slug":"guide-to-git-for-system-administrators","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/guide-to-git-for-system-administrators\/","title":{"rendered":"Guide to Git\u2122 – For System Administrators"},"content":{"rendered":"<\/p>\n
\n
<\/div>\n
\n

Overview<\/h2>\n

The Git Version Control<\/em> feature includes several changes from the Git\u2122 default configuration. Additionally, we impose certain restrictions on cPanel-hosted repositories. This document also includes information that may assist you in troubleshooting cPanel users\u2019 issues.<\/p>\n

Restrictions<\/h2>\n

This feature imposes the following restrictions on cPanel-hosted repositories:<\/p>\n

    \n
  • \n

    Currently, we only support a single remote repository for each local repository. To use multiple remote repositories, users must only<\/strong> use the command line.<\/p>\n<\/li>\n

  • \n

    Users cannot<\/strong> include whitespace or the following characters in repository paths: * | \" ' < > & @ ` $ { } [ ] ( ) ; ? : = % #<\/code><\/p>\n<\/li>\n

  • \n

    Users cannot use this feature to create, delete, or view repositories in the following cPanel-controlled directories:<\/p>\n

      \n
    • .cpanel<\/code><\/li>\n
    • .cphorde<\/code><\/li>\n
    • .htpasswds<\/code><\/li>\n
    • .ssh<\/code><\/li>\n
    • .trash<\/code><\/li>\n
    • access-logs<\/code><\/li>\n
    • cgi-bin<\/code><\/li>\n
    • etc<\/code><\/li>\n
    • logs<\/code><\/li>\n
    • perl5<\/code><\/li>\n
    • mail<\/code><\/li>\n
    • spamassassin<\/code><\/li>\n
    • ssl<\/code><\/li>\n
    • tmp<\/code><\/li>\n
    • var<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
      \n
      Note:<\/div>\n
      \n

      cPanel users cannot<\/strong> use the .<\/code> or ..<\/code> directory references when they enter the repository path in the interface.<\/p>\n<\/p><\/div>\n<\/div>\n

      Configuration changes<\/h2>\n

      This feature alters the following configuration settings:<\/p>\n

        \n
      • gc.auto<\/code> \u2014 We have disabled Git\u2019s garbage-collection setting for all cPanel-managed repositories.<\/li>\n
      • receive.denyCurrentBranch<\/code> \u2014 The system automatically sets this setting in each cPanel-managed repository\u2019s configuration file to the updateInstead<\/code> option.\n
          \n
        • The system ensures this configuration each time that you create a new repository via the VersionControl::create<\/code> function.<\/li>\n
        • The updateInstead<\/code> option causes Git to automatically update the working tree whenever you push changes into the current branch.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

          This feature uses a cPanel-provided Git RPM. The Git RPM symlinks Git binaries in the \/usr\/local\/cpanel\/3rdparty\/bin\/<\/code> directory to the \/usr\/local\/cpanel\/3rdparty\/lib\/path-bin\/<\/code> directory, to cause them to exist in the user\u2019s default path.<\/p>\n

          Deployment<\/h2>\n
          \n
          Important:<\/div>\n
          \n

          We strongly<\/strong> recommend that you only deploy changes from a remote repository or a clone of it on your local computer. You should not<\/strong> directly change the cPanel-managed repository\u2019s contents.
          \nFor more information about our suggested deployment configuration and how to set it up, read our Guide to Git – How to Set Up Deployment documentation.<\/p>\n<\/p><\/div>\n<\/div>\n

          Before deployment, repositories must<\/strong> meet the following requirements:<\/p>\n

            \n
          • A valid checked-in .cpanel.yml<\/code> file in the top-level directory.<\/li>\n
          • One or more local or remote branches.<\/li>\n
          • A clean working tree.<\/li>\n<\/ul>\n

            If a repository does not<\/strong> meet these requirements, the system will not<\/strong> display deployment information. Also, it will disable deployment functionality.<\/p>\n

            \n
            Note:<\/div>\n
            \n
              \n
            • The system adds a post-receive<\/code> hook to all cPanel-managed repositories.\n
                \n
              • This hook will automatically run any commands in the .cpanel.yml file whenever changes deploy.<\/li>\n
              • For more information, read Git\u2019s githooks documentation.<\/li>\n<\/ul>\n<\/li>\n
              • The system stores deployment process-related historical data in an SQLite database within the \/home\/user\/.cpanel\/datastore\/vc_deploy.sqlite<\/code> file, where user<\/code> represents the cPanel account name.<\/li>\n<\/ul><\/div>\n<\/div>\n

                For instructions to set up deployment, read our Guide to Git – How to Set Up Deployment documentation.<\/p>\n

                For more information about deployment, read our Guide to Git – Deployment documentation.<\/p>\n

                SSH host key verification<\/h2>\n

                When users clone a repository via SSH, the system will automatically check for the remote server\u2019s public SSH key in the \/home\/user\/.ssh\/known_hosts<\/code> file, where user<\/code> represents the account\u2019s username.<\/p>\n

                  \n
                • If the remote host is not<\/strong> registered with the system, the system will prompt the user to accept it. Then, it will add it to the \/home\/user\/.ssh\/known_hosts<\/code> file, where user<\/code> represents the account\u2019s username.<\/li>\n
                • If the remote host is already registered, the system will display a confirmation message.<\/li>\n
                • If the remote host\u2019s public key has changed, the system will display a warning.\n
                    \n
                  • For third-party remote hosts, check for announcements about public key updates. Most companies that host repositories make announcements about these changes.<\/li>\n
                  • For remote hosts that you control, consider whether recent events on your system have caused changes to the public key.<\/li>\n
                  • For any private repositories, make certain<\/strong> that you have performed the steps in our Guide to Git – Set Up Access to Private Repositories documentation.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

                    The system also performs these checks each time that a user updates the repository\u2019s information or attempts to pull changes from the repository via the cPanel interface.<\/p>\n

                    \n
                    Warning:<\/div>\n
                    \n

                    If you cannot verify the validity of the change, exercise caution, especially if the repository includes sensitive content. An altered SSH key may indicate a Man-in-the-Middle attack.<\/p>\n<\/p><\/div>\n<\/div>\n

                    In order for users to see these warnings, you must<\/strong> enable the Enable strict SSH host key checking<\/em> setting in the Security<\/em> section of WHM\u2019s Tweak Settings<\/em> interface (WHM >> Home >> Server Configuration >> Tweak Settings<\/em>).<\/p>\n

                    Troubleshooting<\/h2>\n

                    If cPanel users experience problems with their repositories, use the following steps to troubleshoot them.<\/p>\n

                    \n
                    Note:<\/div>\n
                    \n

                    This feature logs messages and errors to the following locations:<\/p>\n

                      \n
                    • \/usr\/local\/cpanel\/logs\/error_log<\/code> \u2014 Errors and stack traces.<\/li>\n
                    • \/home\/username\/.cpanel\/logs\/user_task_runner.log<\/code> \u2014 Queue-related items.<\/li>\n
                    • \/home\/username\/.cpanel\/logs\/vc_TIMESTAMP_git_create.log<\/code> \u2014 Creation-related issues, where TIMESTAMP<\/code> represents the time of the operation.<\/li>\n
                    • \/home\/username\/.cpanel\/logs\/vc_TIMESTAMP_git_deploy.log<\/code> \u2014 Deployment-related issues, where TIMESTAMP<\/code> represents the time of the operation.<\/li>\n<\/ul><\/div>\n<\/div>\n

                      Missing repositories<\/h3>\n

                      If repositories exist on the command line but do not display in cPanel\u2019s Git Version Control<\/em> interface (cPanel >> Home >> Files >> Git Version Control<\/em>), the issue may occur because the feature ignores repositories that users created on the command line.<\/p>\n

                      Missing branches<\/h3>\n

                      If the expected list of branches does not display in cPanel\u2019s Git Version Control<\/em> interface (cPanel >> Home >> Files >> Git Version Control<\/em>), the issue may be due to the following causes:<\/p>\n

                        \n
                      • The branches exist in the copies of the repository on your local computer or remote repository host, but do not<\/strong> exist within the cPanel-managed repository.<\/li>\n
                      • The repository is a bare repository. Bare repositories do not include branches.<\/li>\n<\/ul>\n

                        Cloned repositories<\/h3>\n

                        While the system clones the remote repository, cPanel\u2019s Git Version Control<\/em> interface (cPanel >> Home >> Files >> Git Version Control<\/em>) will only<\/strong> display the repository name and path.<\/p>\n

                        When users clone a repository, the system clones it via a queued process that runs as that cPanel user. Clones can require a large amount of time, which depends on the size of the repository to clone.<\/p>\n

                          \n
                        • \n

                          While the clone process runs, cPanel\u2019s Git Version Control<\/em> interface (cPanel >> Home >> Files >> Git Version Control<\/em>) will only<\/strong> display the repository name, repository path, and a progress indicator. Additionally, the system will temporarily disable most of the management functionality for that repository.<\/p>\n<\/li>\n

                        • \n

                          The process_user_tasks<\/code> binary runs as the cPanel user to process each clone, and the queue for each user exists in their .cpanel\/user_tasks\/<\/code> directory. To resolve issues with clones, stop the process and delete the directory.<\/p>\n<\/li>\n<\/ul>\n

                          SSH access<\/h2>\n

                          If users experience problems with SSH access, ensure that the server and the users\u2019 accounts include the following settings and configurations:<\/p>\n

                            \n
                          • \n

                            Port 22 is publicly accessible. If the server uses a nonstandard Git port, use the ssh -p port<\/code> command, where port<\/code> represents the port number, to SSH in to the account.<\/p>\n<\/li>\n

                          • \n

                            The Shell Access<\/em> setting is enabled for the account in WHM\u2019s Modify an Account<\/em> interface (WHM >> Home >> Account Functions >> Modify an Account<\/em>).<\/p>\n<\/li>\n

                          • \n

                            The SSH Access & Terminal<\/em> feature is enabled for the user\u2019s feature list in WHM\u2019s Feature Manager<\/em> interface (WHM >> Home >> Packages >> Feature Manager<\/em>).<\/p>\n<\/li>\n<\/ul>\n

                            If none of these solutions fix the issue, ensure that the user correctly configured their public<\/strong> SSH keys in cPanel\u2019s SSH Access<\/em> interface (cPanel >> Home >> Security >> SSH Access<\/em>).<\/p>\n

                            \n
                            Note:<\/div>\n
                            \n

                            If a user attempts to clone a remote repository via SSH and receives errors about a refused connection, perform one of the following actions:<\/p>\n

                              \n
                            • Clone the repository via HTTPS in a read-only configuration.<\/li>\n
                            • Register the cPanel account\u2019s SSH key pair with the remote repository\u2019s host as a deployment key.<\/li>\n<\/ul><\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"

                              Overview The Git Version Control feature includes several changes from the Git\u2122 default configuration. Additionally, we impose certain restrictions on cPanel-hosted repositories. This document also includes information that may assist you in troubleshooting cPanel users\u2019 issues. Restrictions This feature imposes the following restrictions on cPanel-hosted repositories: Currently, we only support a single remote repository for …<\/p>\n","protected":false},"author":1,"featured_media":628,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/627"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=627"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/627\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/628"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=627"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=627"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=627"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}