Recommended Setup

What tooling do we recommend

Homebrew

To install homebrew, simply use their setup script:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

rbenv

This is a fantastic tool, especially when needing to utilize many different ruby versions! We highly recommend installing and setting this up on your station.

Once you have this setup, we recommend the following commands be used to install the more common ruby versions we use:

• rbenv install 3.0.1
• rbenv install 3.2.2

macOS setup for rbenv

This is easily done using Homebrew. The command for this is:

brew install rbenv

If you ever need to upgrade it (to get newer ruby versions), you simply would do:

brew upgrade rbenv ruby-build

Linux setup for rbenv

You can use a package manager (such as apt) for this, however we would recommend installing this via git instead. To do this, run the following commands:

git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init - bash)"' >> ~/.bashrc
source ~.bashrc
mkdir -p "$(rbenv root)"/plugins
git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
source ~.bashrc
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/main/bin/rbenv-doctor | bash

To upgrade rbenv and the plugin, you would simply do the following:

cd ~/.rbenv
git pull
cd ~/.rbenv/plugins/ruby-build
git pull

1Password

There are two ways to go about this:

• App based (macOS only)
• Browser based

App based setup for 1Password

To install the 1Password app, you would utilize Homebrew via the following command:

brew install --cask 1password

To upgrade it, you would use:

brew upgrade --cask 1password

Browser based setup for 1Password

You can add this to your Chrome based browser using the 1Password browser plugin for Chrome page.

You can add this to your Firefox based browser using the 1Password browser plugin for Firefox page.

Okta browser plugin

You can add this to your Chrome based browser using the Okta browser plugin for Chrome page.

You can add this to your Firefox based browser using the Okta browser plugin for Firefox page.

Once installed, you simply ensure you are logged into Okta via your browser and it should begin working.

nodenv

This is a fantastic tool, especially when needing to utilize many different node versions! We highly recommend installing and setting this up on your station.

macOS setup for nodenv

This is easily done using Homebrew. The command for this is:

brew install nodenv

If you ever need to upgrade it (to get newer node versions), you simply would do:

brew upgrade nodenv node-build

Linux setup for nodenv

You can use a package manager (such as apt) for this, however we would recommend installing this via git instead. To do this, run the following commands:

git clone https://github.com/nodenv/nodenv.git ~/.nodenv
echo 'export PATH="$HOME/.nodenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(nodenv init -)"' >> ~/.bashrc
source ~.bashrc
mkdir -p "$(nodenv root)"/plugins
git clone https://github.com/nodenv/node-build.git "$(nodenv root)"/plugins/node-build
source ~.bashrc
curl -fsSL https://github.com/nodenv/nodenv-installer/raw/master/bin/nodenv-doctor | bash

To upgrade nodenv and the plugin, you would simply do the following:

cd ~/.nodenv
git pull
cd ~/.nodenv/plugins/node-build
git pull

Openshot Video Editor

This one is only really needed if you need a video editor and do not have a preference. Several of us at GitLab use this and find it very simple to use.

macOS setup for Openshot

This is easily done using Homebrew. The command for this is:

brew install --cask openshot-video-editor

If you ever need to upgrade it, you simply would do:

brew upgrade --cask openshot-video-editor

Linux setup for Openshot

As this is not part of normal package repositories, you’ll need to install a PPA first:

sudo add-apt-repository ppa:openshot.developers/ppa
sudo apt-get update
sudo apt-get install openshot-qt

.bashrc/.bash_profile/.zshrc setup

What exactly you put in this file it really up to you, but to help ensure all the scripts and the like we use work properly, we would at least recommend doing the following:

# us fed ZD instance
export US_ZD_URL='https://gitlab-federal-support.zendesk.com/api/v2'
export US_ZD_USERNAME='YOUR_EMAIL_ADDRESS'
export US_ZD_TOKEN='ZENDESK_US_FEDERAL_ADMIN_TOKEN'

# main ZD instance
export ZD_URL='https://gitlab.zendesk.com/api/v2'
export ZD_USERNAME='YOUR_EMAIL_ADDRESS'
export ZD_TOKEN='ZENDESK_GLOBAL_ADMIN_TOKEN'

# main sandbox
export ZD_SB_URL='https://gitlab1707170878.zendesk.com/api/v2'
export ZD_SB_USERNAME='YOUR_EMAIL_ADDRESS'
export ZD_SB_TOKEN='ZENDESK_GLOBAL_SANDBOX_ADMIN_TOKEN'

# us fed sandbox
export US_SB_ZD_URL='https://gitlabfederalsupport1585318082.zendesk.com/api/v2'
export US_SB_ZD_USERNAME='YOUR_EMAIL_ADDRESS'
export US_SB_ZD_TOKEN='ZENDESK_US_FEDERAL_SANDBOX_ADMIN_TOKEN'

# GitLab token
export GL_TOKEN='YOUR_GITLAB_TOKEN'

Zendesk tokens

As an admin for Zendesk, you are very likely to need to make API calls. Doing this via an API token is useful (and how many of our scripts do it). As such, it is recommend you generate an API token for yourself on every Zendesk instance (production and sandbox) you will be managing.

GitLab token

We often make things that interact with gitlab.com. As such, having an API token handy for API calls is always useful!

Slack

This is going to be required for your job, as we communicate a good bit via Slack.

Slack setup for macOS

This is easily done using Homebrew. The command for this is:

brew install --cask slack

If you ever need to upgrade it, you simply would do:

brew upgrade --cask slack

Slack setup for Linux

To do this, you will want to install the DEB package from the Slack download page and then install the DEB file like so:

sudo dpkg -i /absolute/path/to/deb/file
sudo apt-get install -f

Visual Studios Code

This one is only really needed if you need a code editor and do not have a preference. Several of us at GitLab use this and it aligns with the GitLab WebIDE.

Visual Studios Code setup for macOS

This is easily done using Homebrew. The command for this is:

brew install --cask visual-studio-code

If you ever need to upgrade it, you simply would do:

brew upgrade --cask visual-studio-code

Visual Studios Code setup for Linux

To do this, you will want to install the DEB package from the Visual Studios Code download link and then install the DEB file like so:

sudo dpkg -i /absolute/path/to/deb/file
sudo apt-get install -f

Zoom

This is going to be required for your job, as we communicate a good bit via Zoom.

Zoom setup for macOS

This is easily done using Homebrew. The command for this is:

brew install --cask zoom

If you ever need to upgrade it, you simply would do:

brew upgrade --cask zoom

Zoom setup for Linux

To do this, go to the Zoom download center and download the DEB file. Then install it using the following commands:

sudo dpkg -i /absolute/path/to/deb/file
sudo apt-get install -f

Filesystem setup

We utilize a large number of repositories. While you can do many things in the GitLab UI, you are going to eventually run into the need to utilize command line.

As such, we recommend two things:

1. Have local clones of all the repos we work with (that you have access to)
2. Have a script to mass update them as needed

The exact way you go about this is up to you.

.
└── dev
    ├── gitlab-com
    └── gitlab-support-readiness

.
└── dev
    └── gitlab-support-readiness
        └── zendesk-global
            └── apps

#!/bin/bash

echo 'Updating Customer Support Operations repos...'
CWD=$PWD
find /home/jason/dev/gitlab-support-readiness -type d -name .git | while read dir; do
  path=$(echo $dir | sed s_/".git$"__)
  echo "  Updating $path"
  cd $path
  git submodule update --remote --quiet 2>/dev/null
  git pull -q 2>/dev/null
  if [ $? -eq 1 ]; then
    echo "    Branch issue: $(git branch|grep '*')"
  fi
done
cd $CWD

alias cdops='cd /home/jason/dev/gitlab-support-readiness'
alias cdglobal='cd /home/jason/dev/gitlab-support-readiness/zendesk-global'
alias cdusfed='cd /home/jason/dev/gitlab-support-readiness/zendesk-us-government'
alias cdusgov='cd /home/jason/dev/gitlab-support-readiness/zendesk-us-government'
alias cdforms='cd /home/jason/dev/gitlab-support-readiness/forms'
alias cdprocessor='cd /home/jason/dev/gitlab-support-readiness/processors'
alias cdslack='cd /home/jason/dev/gitlab-support-readiness/slack'
alias cdteam='cd /home/jason/dev/gitlab-support-readiness/support-team'
alias cdhandbook='cd /home/jason/dev/gitlab-com/content-sites/handbook'
alias cdgem='cd /home/jason/dev/gitlab-support-readiness/gitlab_support_readiness_gem'

## Show branch info on PS1

parse_git_branch() {
  git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
}

export PS1="\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\[\e[91m\]\$(parse_git_branch)\[\e[00m\]$ "

Useful links

• Homebrew site
• rbenv repo
• Calendly browser plugin for Chrome
• Calendly browser plugin for Firefox
• 1Password browser plugin for Chrome
• 1Password browser plugin for Firefox
• Okta browser plugin for Chrome
• Okta browser plugin for Firefox
• Slack download page
• Zoom download center

View page source - Edit this page - please contribute.