Skip to content

Get your environment done

Chun Cai edited this page Oct 11, 2021 · 7 revisions

You are trying to run abacus either on your computer or a remote server accessed by ssh.

Developing on a Remote Server

Connect to Remote Server

Use ssh.

And, of course that's not all of this part. We strongly recommend using public key authentication to avoid entering password all the time. This takes two steps:

  • generate a key: ssh-keygen, and
  • put the key onto the server: ssh-copy-id user@host. This is the very last time you enter your password.

For Windows users, follow Install OpenSSH guide to install the ssh and ssh-keygen tools. There is not a ssh-copy-id command on Windows, so you have to do it manually. Try type $env:USERPROFILE\.ssh\id_rsa.pub | ssh user@host "cat >> .ssh/authorized_keys". Read the origin blog post for further information.

Using Linux

Oh-my-zsh

The default shell is bash in most cases. We recomment replacing it with Z shell by the Oh My Zsh tool.

Visual Studio Code

The best editor to use for remote developing. We'll discuss it on a dedicated page.

Developing on Your PC

Windows

WSL

Since abacus does not support Windows officially, use Windows Subsystem for Linux as an alternative: just follow the best practice guide.

WSL2 has huge improvements than WSL1, so be sure you are installing under WSL2 configuration. By wsl --install you will get the proper installation. We suggest you install Linux distributions (e.g. Ubuntu) from Microsoft Store, rather than from Powershell commandline interface, as the former method is more stable.

Please be aware that the file system between WSL and Windows partially shares.

Windows Terminal

Stop using the annoying cmd! Powershell improves little. Try Windows Terminal for a better shell experience under Windows. You can launch WSL simply in a new tab.

Clone this wiki locally