Difference between revisions of "Tabby"
Jeff-strong (talk | contribs) m (Editorial review and minor corrections) |
Jeff-strong (talk | contribs) m (Editorial review and minor corrections) |
||
(3 intermediate revisions by 3 users not shown) | |||
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." | Tabby is "...a terminal for the modern age." You can read more about what Tabby is and isn't [https://tabby.sh on the Tabby home page]. The vast majority of what you'll be doing on {{CM}} involves using a shell that you access through a terminal such as Tabby. | ||
== General Configuration == | == General Configuration == | ||
Tabby requires several steps to | Tabby requires several steps to configure it. 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| | ||
Make sure 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 | {{Box|backgroundColor=whiteSmoke|Access Tabby from the '''My Tools''' menu at 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| | {{Box|backgroundColor=whiteSmoke|At the bottom left of the screen, click '''Login'''. [[File:TabbyOpeningScreen-HighlightedLogin.png|frameless|left|800px]] | ||
<br clear{{Equal}}'all'/> | <br clear{{Equal}}'all'/> | ||
}} | }} | ||
=== Select Authentication Provider === | === Select an Authentication Provider === | ||
{{Box|backgroundColor=whiteSmoke|Click ONE of the following buttons: | {{Box|backgroundColor=whiteSmoke|Click ONE of the following buttons: | ||
* Log in with GitHub | * Log in with GitHub | ||
* Log in with GitLab | * Log in with GitLab | ||
* Log in with Google | * Log in with Google | ||
* (The Microsoft option is not | * (The Microsoft option is not supported) | ||
[[File:TabbySocialLoginButtons.png|frameless|left]] | [[File:TabbySocialLoginButtons.png|frameless|left]] | ||
<br clear{{Equal}}'all'/> | <br clear{{Equal}}'all'/> | ||
}} | }} | ||
=== Log in | === 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 home page.}} | {{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 | === Set Up Config Sync and Connection Gateway === | ||
{{Box|backgroundColor=whiteSmoke|Two | {{Box|backgroundColor=whiteSmoke|Two 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'/> | ||
}} | }} | ||
==== Connection Gateway ==== | ==== Connection Gateway ==== | ||
{{Box|backgroundColor=whiteSmoke| | {{Box|backgroundColor=whiteSmoke|Make sure that the checkbox for '''Use a custom connection gateway''' is selected. | ||
For the '''Gateway address''' enter: | For the '''Gateway address''', enter: | ||
<pre> | <pre> | ||
wss://tabby-gateway.codermerlin.com | wss://tabby-gateway.codermerlin.com | ||
</pre> | </pre> | ||
For the '''Gateway authentication token''' enter: | For the '''Gateway authentication token''', enter: | ||
<pre> | <pre> | ||
1cSaxV0BMABkjAEsV6lFdRK8gkbl0DDc | 1cSaxV0BMABkjAEsV6lFdRK8gkbl0DDc | ||
Line 53: | Line 53: | ||
[[File:TabbyApplyCancelButtons.png|frameless|left|160px]] | [[File:TabbyApplyCancelButtons.png|frameless|left|160px]] | ||
<br clear{{Equal}}'all'/> | <br clear{{Equal}}'all'/> | ||
At the top-right corner of the window, click the Configuration button. 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'/> | ||
Line 61: | Line 61: | ||
https://tabby.codermerlin.com | https://tabby.codermerlin.com | ||
</pre> | </pre> | ||
Click in the "Secret sync token" password field and paste the token that you copied previously. | 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 the '''Profiles & connections''' tab. | 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'/> | ||
Line 84: | Line 84: | ||
For the host, enter: | For the host, enter: | ||
<pre> | <pre> | ||
ssh.codermerlin. | ssh.codermerlin.academy | ||
</pre> | </pre> | ||
For the port, enter: | For the port, enter: | ||
<pre> | <pre> | ||
22 | |||
</pre> | </pre> | ||
For the user name, enter your Coder Merlin user name. | 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 102: | Line 102: | ||
[[File:TabbyConnectionCoderMerlin.png|frameless|left|486px]] | [[File:TabbyConnectionCoderMerlin.png|frameless|left|486px]] | ||
<br clear{{Equal}}'all'/> | <br clear{{Equal}}'all'/> | ||
If you see a page asking you to verify the host key, | If you see a page asking you to verify the host key, make sure you see this fingerprint: | ||
<pre> | <pre> | ||
g94+c/J3u6/rLzVJHP6BIBEZONJhEC7i0B+gkeVcgBo | g94+c/J3u6/rLzVJHP6BIBEZONJhEC7i0B+gkeVcgBo | ||
Line 108: | Line 108: | ||
You may then safely click '''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'/> | |||
}} | |||
===Enabling Copy Paste=== | |||
{{Box|backgroundColor=whiteSmoke| | |||
# Go into settings (top right) | |||
# Go to hotkeys | |||
# Remove every key under pasting | |||
[[File:Screenshot_2023-09-07_3.38.19_PM.png|frameless|left|800px]] | |||
<br clear{{Equal}}'all'/> | <br clear{{Equal}}'all'/> | ||
}} | }} |
Latest revision as of 17:18, 25 September 2023
What is it?[edit]
Tabby is "...a terminal for the modern age." You can read more about what Tabby is and isn't on the Tabby home page. The vast majority of what you'll be doing on Coder Merlin™ involves using a shell that you access through a terminal such as Tabby.
General Configuration[edit]
Tabby requires several steps to configure it. 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]
Make sure that you have a GitHub, GitLab, or Google account configured. This is required to log in to Tabby.
Access[edit]
Login[edit]
Select an 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 supported)
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 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.
Connection Gateway[edit]
Make sure 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
Config Sync[edit]
In the same dialog, use the copy icon to copy the sync token.
Click the Apply button.
At the top-right corner of the window, click the Configuration button. The Application settings page opens.
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.
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.
Click the SSH connection option.
The connection configuration page for SSH opens. For the connection name, use:
Coder Merlin
For the host, enter:
ssh.codermerlin.academy
For the port, enter:
22
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.
Connecting[edit]
From the Tabby home page, click + Profiles & connections.
In the dropdown that appears, click Coder Merlin. The client should connect, and then you'll be prompted to enter your password.
If you see a page asking you to verify the host key, make sure you see this fingerprint:
g94+c/J3u6/rLzVJHP6BIBEZONJhEC7i0B+gkeVcgBo
You may then safely click Accept and remember key.