Configure GitHub in your Linux system using public\private ssh keys instead of username/password

🟩 Step 1 β€” Generate your SSH key pair (public key .pub and private key) at ~/.ssh/

ssh-keygen -t ed25519 -C "your_email@example.com"

🟩 Step 2 β€” Start the SSH agent

eval "$(ssh-agent -s)"

You should see something like:

Agent pid 1234

🟩 Step 3 β€” Copy your pub key to GitHub

cat ~/.ssh/id_ed25519.pub

copy the conent of your .pub key to GitHub

Go to your github profile ➀ Settings ➀ SSH and GPG kyes ➀ New SSH key

Paste the content of your pub key in text box above under the word “Key” and give it a name in textbox above under the word “Title”

🟩 Step 4 β€” tell SSH client which private key to use which is paired to the pub key used at GitHub earlier

e.g under current’s user .ssh folder

mkdir -p ~/.ssh
chmod 700 ~/.ssh
nano ~/.ssh/config

Add:

Host *
AddKeysToAgent yes
IdentityFile ~/.ssh/id_ed25519

ctrl-o to write and ctrl-x to close nano.

Then secure it:

chmod 600 ~/.ssh/config

🟩 Step 5 – testing it

ssh -T git@github.com

you should see sth like this:

Hi github_username! You've successfully authenticated, but GitHub does not provide shell access.

Linux Tree command

tree -f -I build

where -f is to include file with full path. -I mean to exclude specific folder

I do like this util tool in Linux though it does not always come with the distro and I have to install it.

e.g: sample output from my kali linux VM:

β”Œβ”€β”€(rootγ‰Ώkali)-[/home/catch2-mini-book/project]
└─# tree -f -I build
.
β”œβ”€β”€ ./CMakeLists.txt
β”œβ”€β”€ ./external
β”‚   β”œβ”€β”€ ./external/catch_amalgamated.cpp
β”‚   └── ./external/catch_amalgamated.hpp
β”œβ”€β”€ ./id_git_hub_chanvicheka_ouk
β”œβ”€β”€ ./id_git_hub_chanvicheka_ouk.pub
β”œβ”€β”€ ./include
β”‚   β”œβ”€β”€ ./include/account.hpp
β”‚   β”œβ”€β”€ ./include/logger.hpp
β”‚   β”œβ”€β”€ ./include/logic.hpp
β”‚   β”œβ”€β”€ ./include/service.hpp
β”‚   └── ./include/shape.hpp
β”œβ”€β”€ ./README.md
β”œβ”€β”€ ./src
β”‚   └── ./src/logic.cpp
β”œβ”€β”€ ./test_example
β”œβ”€β”€ ./test_main.o
β”œβ”€β”€ ./test_runner
└── ./tests
β”œβ”€β”€ ./tests/test_example.cpp
β”œβ”€β”€ ./tests/test_main.cpp
β”œβ”€β”€ ./tests/test_oop_composition_class_with_dependencies.cpp
β”œβ”€β”€ ./tests/test_oop_inheritance_polymorphism.cpp
β”œβ”€β”€ ./tests/test_oop_simple.cpp
β”œβ”€β”€ ./tests/test_oop_using_fixture.cpp
└── ./tests/test_parameterization.cpp

5 directories, 22 files

Checking Latest Centos Linux Distribution

Through my professional career, I was tasked to start support our client on Linux since our competitor started supporting theirs on Linux. I started developing our C# daemon service that acted as a client loader (it periodically talks to the enterprise to see if there are any packages scheduled to be deployed/downloaded and transferred to target client – Linux platform). it runs at startup in the background, and it is in fact a WCF where its front-end client is an embedded browser ChromiumΒ EmbeddedΒ FrameworkΒ (CEF) running Html/Css/Js etc for the UI and it interacts to this client loader C# daemon (wcf) through its service contract. I really love this project since I started its development from scratch and I learned a lots about Linux. I learned about firewalld (we locked down lots of ports by default for security), Linux securities (proxy, sudoers etc..), learn how to launch UI application since our Linux Image does not have desktop, bash script (for automation rpm build and within rpm itself), systemd (for daemon service related), bash script for automation, learned how to build rpm since we need to bundle its related files (dependencies dlls, noted we use mono so I have to bundle mono with it as well) as an rpm which can then be easily preinstalled on our Linux Hardware image by our hardware team, which we periodically release internally with our hardware team (yes we sell our enterprise application with our discounted Hardware devices e.g end user only has to pay $1 for the device as long as they buy our software contract). I also automated its rpm build nightly using Jenkin hudson where the Hudson jenkins agent running in Windows would execute its job per schedule in Hudson job configuration and I used it to execute some automation win32 batch scripts where it does automated things like Msbuild our .sln and then copied the related output files passwordless via ssh using private/public key to our Linux build machine where its designated bash script would then be executed for the rpm build. I wrote both the windows batch script and also Linux bash script for the automation of our daemon rpm nightly build so I can share the output rpm internally between hardware team and qa team to test it.

Also, when we started our development, we tried it with Ubuntu, later Centos, then Oracle Linux. And Oracle Linux is quite similiar to Centos because both are the Rebuilds of Red Hat Enterprise Linux (RHEL)

Our client is now running on Linux using .Net Core and now .Net 8

Note:

I just noticed that I wrote my full name wrong urgh.

Using latest VirtualBox Downloads – Oracle VirtualBox with latest Centos image Download – The CentOS Project

Latest Centos is still looking cool. Actually I do like it more than Ubuntu.

I will install C++ on this Linux VM e.g gcc/g++/cmake etc.. for my own project πŸ™‚

Setup a simple Apache Web server in AWS ec2 cloud Amazon Linux instance to demonstrate a practical concept of CI/CD deployment stage to the target Linux web server

  1. Setup aws ec2 cloud amazon linux and install Apache HTTP WebServer (httpd)
  2. Configure the handshake between GitLab’s CI/CD pipeline and Apache WebServer through ssh using private/public key
  3. Give GitLab CI/CD pipeline instruction in .gitlab-ci.yml

First, let setup our web server using aws ec2 cloud amazon linux instance and then install Apache WebSever


Name: Web-Server

Choose Amazone Linux

Use my existing keypair

In Network settings section, we are going to click on Edit and Click Add security group rule

Note: for the simplicity of this post/demonstration, I choose http type (I know it is not secured) because if we choose https we have to configure and use tls for traffic encryption but that is not the intention of this post so I will go with http for simplicity’s sake.

Go ahead and we click on Launch instance ec2

Ok our designated Web-server linux instance is running.

Note down its ip address above

at our win machine, we will remote ssh to it using private key MyLinux.pem so we can then install our Apache web server there

we are connected. next, we will have to elevate ourselves to root with sudo -i so we can install the Apache web server

Next, we will yum install it where httpd is the Apache Web Server.

type y and enter to confirm the installation

install completed and this looks good so let start and check the status of our Apache web server daemon service

  • systemctl start httpd
  • systemctl status httpd

Good, it started and running with pid 25664

we can check it in the task managers with ps aux | grep 25664

yes it is there running as daemon /usr/sbin/httpd -DFORGROUND

let makes it run at start up with systemctl enable httpd

let check our web server through the browser client to make sure it is actually running as well and listing on port 80 that we have configured in the security group rule

By going to the browser and type our web server amazon linux public ip address (note we don’t have to specify its default 80) and yes it is running and listening on port 80 as expected

Second, we need to configure the handshake between our web server here and gitlab.


that is being said, we will do that through ssh where gitlab will use private key and our apache webserver would then use the mactching public key so gitlab can remotely deploy stuff to our apache web server. So let turn on public key authentication for our apache web server:

Enable Public Key Authentication in SSH Server

sudo vi /etc/ssh/sshd_config

scroll down and we will see that pubkey auth is commented out by default so we are going to uncomment it. press i for writing mode and remove #

press esc then type :wq to write and quit

since we made a change in its configuration file, we need to restart it so the change will be taken into account with systemctl restart httpd

check its status: systemctl status httpd

Ok good it is running and taken into account our configuration change.

Next we will need to generate public/private key pair from our local repo which is windows

and save it at c:\webkey folder with ssh-keygen -t rsa -b 4096

Next, getting my remote repo “projectX” to my local repo since I already have remote repo “projectX” at the GitLab so I will just clone it in my local directory

Next, copy our public key id_rsa.pub from our local repo id_rsa.pub and input it in our webserver’s public key aka “authorized_key”

Logout from root and cd to the hidden folder .ssh

cd to the hidden .ssh and we will see authorized_keys file there

vi authozied_keys

press i for writing mode and then copy our public key from our windows local repo id_rsa.pub

and paste in this authorized_keys file and save it

press esc then :wq to write and quit vi

Good that concludes that we have configure public key in our designated webserver Apache.

Next we will configure private key in our GitLab.

Project β†’ Settings β†’ CI/CD β†’ Variables β†’ Project variables and click on Add varaible

scroll down till you see below two value key/value pair

Give Key as SSH_PRIVATE_KEY and Value we will copy and paste the private key we generated from our local repo in windows PC

this concludes the handshake btw our GitLab’s CI/CD pipeline and AWS EC2 Linux Apache WebServer where CI/CD would use privatekey and the WebServer would use the matching public key.

Third, we will have to configure our .gitlab-ci.yml for set of instruction for ci/cd pipeline


image: node:latest

stages:
- test
- deploy

# -------------------------
# Test Stage
# -------------------------
test-job:
stage: test
script:
- npm install -g html-validator-cli
- html-validator --file=index.html --verbose
only:
- main

# -------------------------
# Deploy Stage
# -------------------------
deploy_to_server:
stage: deploy
before_script:
- apt-get update -y && apt-get install -y openssh-client
- mkdir -p ~/.ssh
- echo "$SSH_PRIVATE_KEY" | tr -d '\r' > ~/.ssh/id_rsa
- chmod 600 ~/.ssh/id_rsa
script:
- scp -i ~/.ssh/id_rsa -o StrictHostKeyChecking=no index.html ec2-user@18.191.251.195:/var/www/html/
only:
- main
  • First we tell gitlab that we want an image that have node js already installed as it has a dependency with html-validator-cli that we used in the test job on ubuntu runner.
  • 2nd we only want two stage test and deploy
  • For test job, we will use ubuntu and install html-validator-cli and use it to valide our index.html for html syntax (note index.html I already created in the repo ProjectX)
  • For deploy job, we update our ubuntu and install openssh-client.
    • create .ssh at root home directory on Ubuntu
    • then write the privatekey value from our gitlab project variable SSH_PRIVATE_KEY to ~/.ssh/id_rsa on Ubuntu (~ mean home directory and in this case the home of the root user)
    • Finally securely copied index.html from Ubuntu over the network to our designated AWS ec2 cloud Apache Webserver at ec2-user@18.191.251.195 and put it in directory /var/www/html which is the main directory of our Apache webserver : authentication with ~/.ssh/id_rsa which is the private key value written from $SSH_PRIVATE_KEY variable.
  • only: - main means:
    β€œRun this job only when the pipeline is triggered from the main branch.”

Our index.html from GitLab should look like this after GitLab CI/CD validate its html syntax and deploy it to the target webserver at AWS EC2.

<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<title>Colored Text Example</title>
<style>
:root {
--accent-color: #0077cc; /* change this to update the accent color site-wide */
}

body {
font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial;
line-height: 1.5;
padding: 2rem;
color: #222; /* default text color */
background: #f8f9fb;
}

.accent {
color: var(--accent-color);
}

.muted {
color: #6b7280; /* gray */
}

.danger {
color: #cc0000; /* red */
}
</style>
</head>
<body>
<h1 class="accent">Welcome β€” colored text demo</h1>

<p>This paragraph uses the default text color.</p>

<p class="muted">This paragraph uses a muted (gray) color.</p>

<p class="danger">This paragraph uses a "danger" (red) color.</p>

<p style="color: #2a9d8f;">This paragraph is colored with an inline style (#2a9d8f).</p>

<p>To change the main accent color site-wide, edit the <code>--accent-color</code> in the <code>:root</code> CSS rule.</p>
</body>
</html>

our index.html

Now let check our CI/CD pipeline deploy stag’s logging.

It runs successfully and deployed index.html from remote repo in GitLab to the target AWS EC2 cloud Apache Web server at default directory /var/www/html

so if we go to the browser and put in our web server public ip, the web server should render our index.html. (note the Not Secure because we use http protocol instead of https as using https requires TLS configure which is not intended for this simplicity of this post)

Voila works as expected.

This conclude that our CI/CD deploy stage is able to deploy work to targeted AWS EC2 cloud Apache web server on Amazon Linux successfully.

Setup self-managed GitLab runner on AWS ec2 cloud

To refresh our memory: What is GitLab runner?

Runner is a GitLab component that actually executes our CI/CD pipeline (Continuous Integration (CI)/Continuous Delivery (CD) ).

We define our CI/CD pipeline stage and job using its .gitlab-ci.yml (.yaml) file which defines jobs (like builds, tests, deploys), the runner is what runs those scripts on some compute environment e.g our aws ec2 cloud instance amazon linux.

Example of .gitlab-ci.yml looks like

stages:
- build
- test
- deploy

build-job:
stage: build
script:
- echo "Hello, $GITLAB_USER_LOGIN!"

test-job1:
stage: test
script:
- echo "This job tests something"

test-job2:
stage: test
script:
- echo "This job tests something, but takes more time than test-job1."
- echo "After the echo commands complete, it runs the sleep command for 20 seconds"
- echo "which simulates a test that runs 20 seconds longer than test-job1"
- sleep 20

deploy-prod:
stage: deploy
script:
- echo "This job deploys something from the $CI_COMMIT_BRANCH branch."
environment: production

with .yml above, it is like set of instruction that we tell how GitLab would run the runners for our CI/CD pipeline. Like above, we tell GitLab that the runner would have 3 stages

first stage is build, second stage is test, and third stage is deploy.

then we can add job that linked to the stage by

stage: <stage_name>

stage:
- <stage_name>

<job_name>:
- stage: <stage_name>
- script:
<script_statements>

e.g above Example of .gitlab-ci.yml, we only have one build job, two run jobs (one short, one longer), last but not least, we have one deploy job.

How it works

When we use GitLab SaaS (e.g., our project is hosted at gitlab.com):

  1. We define CI/CD jobs in .gitlab-ci.yml.
  2. GitLab’s shared runners (SaaS runners) automatically pick up our jobs.
  3. They execute them in isolated environments (typically Docker containers).
  4. Results (logs, artifacts, statuses) are sent back to our GitLab project.

But Saas runner is just one type of runners that GitLab supported.

GitLab Runner SaaS refers to GitLab’s managed runners β€” runners hosted and maintained by GitLab itself.

Types of Runners

TypeDescriptionManaged By
SaaS / Shared RunnerPreconfigured runners available for all projects on GitLab.comGitLab
Group or Project RunnerDedicated to our group or project, still hosted by GitLabGitLab
Self-Managed RunnerInstalled and maintained by us (e.g. on our own VM or cluster)Us

So today, we explore how we can setup and managed our runner. And we will use AWS ec2 cloud Amazon Linux to demonstrate it here:

Please have a look at below link which I already covered briefly how to get AWS ec2 instance running and ssh to it remotely using private key:

Connecting local git repo with remote GitHub repo in AWS Linux instance – csforce.de | VIC: Setup self-managed GitLab runner on AWS ec2 cloud

First we will have to add GitLab runner repo and then yum install it:

by executing below curl piped command to add the repo & yum install command to install it at terminal:

# Add the official GitLab Runner repository
curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.rpm.sh | sudo bash

# Install the runner
sudo yum install gitlab-runner -y

after the piped command we should see this which mean our gitlab repo is added to our amazon linux distro repos:

This looks good our GitLab’s runner is now installed in our AWS ec2 cloud linux distro successfully.

Next, we need to setup our GitLab’s repo and point our runner to our AWS ec2 cloud linux runner instance.

Go to our project’s repository, then navigate to Settings β†’ CI/CD β†’ Runners, and disable the instance (SaaS) runners by toggling them off.

Next, go to Project Runners β†’ Create project runner

For the simplicity, we will check untagged and click create runner

Choose Linux since our AWS cloud is EC2 Amazon linux

And copied and paste the following command at our aws ec2 cloud instance (amazon linux) to register it there (to link them: Gitlab <-> aws ec2 linux runner instance)

hit enter since we will use the default url https://gitlab.com

and enter “linuxrunner” as the name our self-managed runner here:

next type shell for the executor and hit enter (since this is a simple demonstration of the setup of self-managed runner, we chose shell for our .gitlab-ci.yml’s script aka bash, but if you want you can choose vm, or docker etc and chose by typing the executor type here)

This looks good:

  • we use https://gitlab.com as instance url,
  • named it “linuxrunner”
  • and chose shell as an executor.

At our GitLab project settings CI/CD we would see this below:

Click on View runners and we should see our project runner is registered successfully and online (green means it is online)

Note that our simple .gitlab-ci.yml is as below: 3 stages (build, test, deploy), 1 build job, 2 test jobs, and one deploy job.

so any commit to our main branch of our project branch would trigger the pipeline as seen below:

All the jobs completed and passed successfully

We can check our ci/cd pipeline jobs log as seen above and we saw that our script were executed successfully.

This concluded that we have pointed our project’s CI/CD pipeline runner to our self-managed runner on AWS EC2 cloud Amzon Linux successfully.

In addition, how do we check the status of our runner whether it is running or not?

our runner is actually a daemon. think of daemon like a windows service which we can check using service.msc but how do we check the status of daemon service in linux?

A Linux daemon service is a background process that runs continuously on a Linux system, typically without direct user interaction. Daemons are often used for system or network services β€” like web servers, database servers, or schedulers β€” and are managed using the systemd service manager in most modern Linux distributions.

in centos family like Amazon linux distribution, we can check it using

 sudo systemctl status <daemon_service_name>
e.g:
sudo systemctl status gitlab-runner

to make gitlab-runner daemon service run automatically at start up we can execute command below:

sudo systemctl enable gitlab-runner

To start/stop it:

sudo systemctl start gitlab-runner
sudo systemctl stop gitlab-runner

Connecting local git repo with remote GitHub repo in AWS Linux instance

First of all, go to Amazon AWS and create our free AWS account and saved its private key.

Once we login to our aws console, we can search ec2 and since I have visited it before here I will just click on EC2

Then click on Launch instance

We are going to use Amazon Linux

Ok it launched successfully. Then click on its instance name guid as seen above “i-075f2…”

Note down the ip address since we are going to connect to it using our saved private key. we will use our private key “MyLinux.pem” to connect to it which matched with its public key at Amazon AWS server.

At Command prompt execute:

We are now connected with our Amazon AWS EC2 instance.

Note the user name is always ec2-user for amazon linux OS.

I am going to execute Linux update with yum update command:

but we do not have the privilege to do it so we will have to elevate ourself to root with following command sudo -i

We are now root so we should be able to upgrade our Linux to its latest repo with

yum update

That looks good. our AWS linux instance is update to date with its Kernel repo.

git is not installed yet so we will have to install it with yum install git

yum install git

type y to proceed

Git install is completed

Next we will create a directory called mylinuxrepo

Check if it is created with ls -l

cd to our mylinuxrepo directory and issue git status

it is not a git local repo yet so we will have to convert it to local git reposity with git init

Now check agian with git status

Ok now it is a local git repo. let create a bash script called addcal.py using vi editor

Press i for insertion mode (writing mode)

press esc (for mode) and type :wq (w mean write and q mean quit) to write and quit

addcal.py is created and let execute it with bash addcal.py

Good our bash script is working.

Note: Also my bad it is not a python script and accidentially naming it .py but it does not matter the name.

Good, next we will stage it and commit it

Note that I forgot to set the git config –global user.name and git config –global user.email

you can easily configure this e.g:

git config –global user.name myuserame

git config –global user.email myusername@gmail.com

Next, we will have to link it to the central distributed remote repo aka GitHub

Note, also authentication in linux with username, password would not work and we would have to use personal access token.

Ok now connect our local repo to remote repo in GitHub

Here when authentication through https with username/password would never work here in Linux so we will have to use token

Go to your GitHub profile and setting and click on Developer settings

Click on Token (classic) and click Generate a new token

Checked repo and Click Generate token button at the buttom

Copy the token and saved it to somewhere secured

Now let try to add our local git repo to remote git hub repo:

When prompt with Password, past the copied token and here we now successfully link and push our local change in our local git repo to the remote github repo:

Note: I have to delete this token after this post πŸ™‚

Linux Shell Exit Code

if your program returns -1, the linux shell receives the exit code as an 8-bit unsigned integer (0–255)

So what would be the value that Linux shell would receive if you return -1 from your application?

The kernel takes your int return value and maps it to 8 bits unsigned.

Negative numbers are converted using mod 256:

-1 mod 256 = 255

That’s why when you run:

./myprogram
echo $?

the echo will show 255 instead of -1 as you might have falsely expected.

Key takeaway

  • Linux exit codes are always unsigned 8-bit values (0–255).
  • Returning negative values in your program gets wrapped modulo 256.
  • Common convention:
    • 0 β†’ success
    • Non-zero β†’ error

Tip:

If you want to return an error code to the shell, always use 0–255 to avoid confusion. Returning -1 is technically allowed but becomes 255 in the shell.

Use 0 for success and 1–255 for errors to avoid confusion.

If you want a β€œstandard” error code in Linux, just use 1 instead of -1

This is important to be aware of esp if you develop software using C# with mono or .net core where you might have a bash script that would automate task based on specific exit code from one of your linux C#/mono app.