Difference between revisions of "Tabby"

From Coder Merlin
m (Editorial review and minor corrections)
Line 1: Line 1:
[[File:TabbyLogo.png|right]]
[[File:TabbyLogo.png|right]]
== What is it? ==
== What is it? ==
Tabby is "...a terminal for the modern age."  You can read more about what Tabby is and isn't [https://tabby.sh here]. The vast majority of what you'll be doing on {{CM}} will involve the use of a shell, which you'll access through a terminal such as Tabby.
Tabby is "...a terminal for the modern age."  You can read more about what Tabby is and isn't [https://tabby.sh here]. The vast majority of what you'll be doing on {{CM}} will involve using a shell that you'll access through a terminal such as Tabby.
== General Configuration ==
== General Configuration ==
Tabby requires several steps to complete its configuration. Most of these steps need only be performed once because Tabby will store the configuration remotely (in the "Cloud"). It's very important to follow the instructions carefully.
Tabby requires several steps to complete its configuration. Most of these steps need to be performed only once because Tabby stores the configuration remotely (in the Cloud). It's very important to follow the instructions carefully.
=== GitHub, GitLab, or Google Account Required ===
=== GitHub, GitLab, or Google Account Required ===
{{Box|backgroundColor=whiteSmoke|
{{Box|backgroundColor=whiteSmoke|
Ensure that you have a GitHub, GitLab, or Google account configured. This is required in order to log in to Tabby.
Ensure that you have a GitHub, GitLab, or Google account configured. This is required to log in to Tabby.
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
}}
}}
=== Access ===
=== Access ===
{{Box|backgroundColor=whiteSmoke|Access Tabby from the "My Tools" menu in the top left of your screen. Then click the "Shell" button. In a few moments, Tabby will open. [[File:TabbyOpeningScreen.png|frameless|left|800px]]
{{Box|backgroundColor=whiteSmoke|Access Tabby from the "My Tools" menu in the top left of your screen. Then click the "Shell" button. Tabby opens. [[File:TabbyOpeningScreen.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
}}
}}
=== Login ===
=== Login ===
{{Box|backgroundColor=whiteSmoke|On the bottom left of the screen click the Login button. [[File:TabbyOpeningScreen-HighlightedLogin.png|frameless|left|800px]]
{{Box|backgroundColor=whiteSmoke|On the bottom left of the screen, click Login. [[File:TabbyOpeningScreen-HighlightedLogin.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
}}
}}
Line 27: Line 27:
}}
}}
=== Log in To Tabby ===
=== Log in To Tabby ===
{{Box|backgroundColor=whiteSmoke|Follow the login flow for your selected provider. After successfully logging in, you'll be returned to the Tabby homepage.}}
{{Box|backgroundColor=whiteSmoke|Follow the login flow for your selected provider. After successfully logging in, you'll be returned to the Tabby home page.}}
=== Set up Config Sync and Connection Gateway ===
=== Set up Config Sync and Connection Gateway ===
{{Box|backgroundColor=whiteSmoke|There are two different configuration buttons (⚙) that are both called "Settings".  In the below image, the red ovals indicate the button used primarily for application customizations. The cyan rectangle indicates the button used for configuring synchronization and the connection gateway. Click on the settings button indicated within the cyan rectangle.  
{{Box|backgroundColor=whiteSmoke|Two different configuration buttons (⚙) can be used. They are both called "Settings." In the below image, the red ovals indicate the button used primarily for application customizations. The cyan rectangle indicates the button used for configuring synchronization and the connection gateway. Click the settings button indicated in the cyan rectangle.  
[[File:TabbyConfigurationButtonLocations.png|frameless|left|800px]]
[[File:TabbyConfigurationButtonLocations.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
Line 53: Line 53:
[[File:TabbyApplyCancelButtons.png|frameless|left|160px]]
[[File:TabbyApplyCancelButtons.png|frameless|left|160px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
Click on the configuration button in the top-right corner of the window.  The Application settings page will open.
Click the configuration button in the top-right corner of the window.  The Application settings page opens.
[[File:TabbyApplicationSettings.png|frameless|left|800px]]
[[File:TabbyApplicationSettings.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
On the left-hand side, click on the '''Config sync''' tab.
On the left-hand side, click the '''Config sync''' tab.
For the '''Sync host''', enter:
For the '''Sync host''', enter:
<pre>
<pre>
https://tabby.codermerlin.com
https://tabby.codermerlin.com
</pre>
</pre>
Click on the "Secret sync token" password field and paste the token that you copied previously.  Click on "↓ Download" to download a configuration. Then, turn on '''Sync automatically'''.
Click in the "Secret sync token" password field and paste the token that you copied previously.  Click "↓ Download" to download a configuration. Then, turn on '''Sync automatically'''.
[[File:TabbyConfigSyncDialogWithMarkup.png|frameless|left|800px]]
[[File:TabbyConfigSyncDialogWithMarkup.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
Line 72: Line 72:
== Connection Configuration ==
== Connection Configuration ==
{{Box|backgroundColor=whiteSmoke|
{{Box|backgroundColor=whiteSmoke|
On the left-hand side, click on the '''Profiles & connections''' tab.  The '''Profiles''' page will open. Click on the '''+ New profile''' button.
On the left-hand side, click the '''Profiles & connections''' tab.  The '''Profiles''' page opens. Click the '''+ New profile''' button.
[[File:TabbyProfileDialogWithMarkup.png|frameless|left|800px]]
[[File:TabbyProfileDialogWithMarkup.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
Click on the '''SSH connection''' option.
Click the '''SSH connection''' option.
[[File:TabbySSHConnectionBaseProfile.png|frameless|left|480px]]
[[File:TabbySSHConnectionBaseProfile.png|frameless|left|480px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
The connection configuration page for SSH will open. For the connection name, use:
The connection configuration page for SSH opens. For the connection name, use:
<pre>
<pre>
Coder Merlin
Coder Merlin
Line 90: Line 90:
443
443
</pre>
</pre>
For the user name, enter your Coder Merlin username.  Finally, be sure to click on '''Password''' for '''Authentication method'''.  Verify your entries, then click on the '''Save''' button.  Then, close the '''Settings''' tab.
For the user name, enter your Coder Merlin user name.  Finally, be sure to click '''Password''' for '''Authentication method'''.  Verify your entries, then click the '''Save''' button.  Then, close the '''Settings''' tab.
[[File:TabbyCoderMerlinSSHConfiguration.png|frameless|left|792px]]
[[File:TabbyCoderMerlinSSHConfiguration.png|frameless|left|792px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
Line 96: Line 96:


== Connecting ==
== Connecting ==
{{Box|backgroundColor=whiteSmoke|From the home page, click on '''+ Profiles & connections'''.
{{Box|backgroundColor=whiteSmoke|From the Tabby home page, click '''+ Profiles & connections'''.
[[File:TabbyOpeningScreen-HighlightedProfiles.png|frameless|left|800px]]
[[File:TabbyOpeningScreen-HighlightedProfiles.png|frameless|left|800px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
In the dropdown that appears, click on '''Coder Merlin'''.  The client should connect, and then you'll be prompted to enter your password.
In the dropdown that appears, click '''Coder Merlin'''.  The client should connect, and then you'll be prompted to enter your password.
[[File:TabbyConnectionCoderMerlin.png|frameless|left|486px]]
[[File:TabbyConnectionCoderMerlin.png|frameless|left|486px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
Line 106: Line 106:
g94+c/J3u6/rLzVJHP6BIBEZONJhEC7i0B+gkeVcgBo
g94+c/J3u6/rLzVJHP6BIBEZONJhEC7i0B+gkeVcgBo
</pre>
</pre>
You may then safely click on '''Accept and remember key'''.
You may then safely click '''Accept and remember key'''.
[[File:TabbyHostKeyVerification.png|frameless|left|490px]]
[[File:TabbyHostKeyVerification.png|frameless|left|490px]]
<br clear{{Equal}}'all'/>
<br clear{{Equal}}'all'/>
}}
}}

Revision as of 03:10, 22 August 2022

Within these castle walls be forged Mavens of Computer Science ...
— Merlin, The Coder
TabbyLogo.png

What is it?[edit]

Tabby is "...a terminal for the modern age." You can read more about what Tabby is and isn't here. The vast majority of what you'll be doing on  Coder Merlin™  will involve using a shell that you'll access through a terminal such as Tabby.

General Configuration[edit]

Tabby requires several steps to complete its configuration. Most of these steps need to be performed only once because Tabby stores the configuration remotely (in the Cloud). It's very important to follow the instructions carefully.

GitHub, GitLab, or Google Account Required[edit]

Ensure that you have a GitHub, GitLab, or Google account configured. This is required to log in to Tabby.

Access[edit]

Access Tabby from the "My Tools" menu in the top left of your screen. Then click the "Shell" button. Tabby opens.
TabbyOpeningScreen.png


Login[edit]

On the bottom left of the screen, click Login.
TabbyOpeningScreen-HighlightedLogin.png


Select Authentication Provider[edit]

Click ONE of the following buttons:

  • Log in with GitHub
  • Log in with GitLab
  • Log in with Google
  • (The Microsoft option is not currently supported)
TabbySocialLoginButtons.png


Log in To Tabby[edit]

Follow the login flow for your selected provider. After successfully logging in, you'll be returned to the Tabby home page.

Set up Config Sync and Connection Gateway[edit]

Two different configuration buttons (⚙) can be used. They are both called "Settings." In the below image, the red ovals indicate the button used primarily for application customizations. The cyan rectangle indicates the button used for configuring synchronization and the connection gateway. Click the settings button indicated in the cyan rectangle.

TabbyConfigurationButtonLocations.png


Connection Gateway[edit]

Ensure that the checkbox for Use a custom connection gateway is selected. For the Gateway address enter: 

wss://tabby-gateway.codermerlin.com

For the Gateway authentication token enter: 

1cSaxV0BMABkjAEsV6lFdRK8gkbl0DDc
TabbyGatewayConfiguration.png


Config Sync[edit]

In the same dialog, use the copy icon to copy the sync token.

TabbyConfigSyncCopyIcon.png


Click the Apply button.

TabbyApplyCancelButtons.png


Click the configuration button in the top-right corner of the window. The Application settings page opens.

TabbyApplicationSettings.png


On the left-hand side, click the Config sync tab. For the Sync host, enter: 

https://tabby.codermerlin.com

Click in the "Secret sync token" password field and paste the token that you copied previously. Click "↓ Download" to download a configuration. Then, turn on Sync automatically.

TabbyConfigSyncDialogWithMarkup.png


Sample Configuration File[edit]

In most cases, you can simply replace the existing configuration file with the contents of this link and skip the remaining steps: Tabby.csv

Connection Configuration[edit]

On the left-hand side, click the Profiles & connections tab. The Profiles page opens. Click the + New profile button.

TabbyProfileDialogWithMarkup.png


Click the SSH connection option.

TabbySSHConnectionBaseProfile.png


The connection configuration page for SSH opens. For the connection name, use: 

Coder Merlin

For the host, enter: 

ssh.codermerlin.com

For the port, enter: 

443

For the user name, enter your Coder Merlin user name. Finally, be sure to click Password for Authentication method. Verify your entries, then click the Save button. Then, close the Settings tab.

TabbyCoderMerlinSSHConfiguration.png


Connecting[edit]

From the Tabby home page, click + Profiles & connections.

TabbyOpeningScreen-HighlightedProfiles.png


In the dropdown that appears, click Coder Merlin. The client should connect, and then you'll be prompted to enter your password.

TabbyConnectionCoderMerlin.png


If you see a page asking you to verify the host key, ensure that you see this fingerprint: 

g94+c/J3u6/rLzVJHP6BIBEZONJhEC7i0B+gkeVcgBo

You may then safely click Accept and remember key.

TabbyHostKeyVerification.png


Retrieved from "https://www.codermerlin.academy/wiki/index.php?title=Tabby&oldid=17872"