Summary:
Section titled “Summary:”This article provides step-by-step instructions to install Phanes on a Windows computer. Installation is performed via WSL2 and Ubuntu, as Phanes is designed to run in a Linux environment.
Who is this KB written for?:
Section titled “Who is this KB written for?:”Service Desk
When should this KB be referenced?:
Section titled “When should this KB be referenced?:”When Phanes install is requested
Overview
Section titled “Overview”This article provides step-by-step instructions to install Phanes on a Windows computer. Installation is performed via WSL2 and Ubuntu, as Phanes is designed to run in a Linux environment.
Prerequisites
Section titled “Prerequisites”You must have:
- Install Rust KB00064518
- Install Git KB00064575
- Install Docker KB00064527
- Windows 10 or later
- Virtualization enabled in BIOS
- Hyper-V enabled
- WSL2 installed & configured
- Internet access
- GitLab account with access to Phanes repository
- Docker Desktop for Windows
1. Enable Virtualization
Section titled “1. Enable Virtualization”- Reboot your PC and enter BIOS/UEFI settings (usually by pressing
F2,Del,F10, or similar at boot). - Locate the setting for Virtualization or Intel VT-x/AMD-V, and make sure it is Enabled.
- Save and exit BIOS.
2. Enable Hyper-V
Section titled “2. Enable Hyper-V”- Press
Windows Key + S, type “Turn Windows features on or off” and press Enter. - In the list, check:
- Hyper-V
- Windows Subsystem for Linux
- Virtual Machine Platform
- Click OK and restart your computer when prompted.
3. Install WSL2 and Ubuntu
Section titled “3. Install WSL2 and Ubuntu”- Open PowerShell as Administrator and run:
cmd
Copy code
wsl --install -d Ubuntu
- If already installed, confirm your WSL version with:
cmd
Copy code
wsl --list --verbose
- If Ubuntu is set to version 1, convert to version 2:
cmd
Copy code
wsl --set-version Ubuntu 2
- Launch Ubuntu from the Start Menu and complete the initial setup (create user and password).
Setting Up the Ubuntu (WSL) Environment
Section titled “Setting Up the Ubuntu (WSL) Environment”Perform the following steps inside your Ubuntu terminal:
4. Update Package Manager
Section titled “4. Update Package Manager”bash
Copy code
sudo apt update sudo apt upgrade -y
5. Install Dependencies
Section titled “5. Install Dependencies”bash
Copy code
sudo apt install git docker.io pkg-config libssl-dev apt-transport-https ca-certificates gnupg curl make -y
6. Install Google Cloud SDK and kubectl
Section titled “6. Install Google Cloud SDK and kubectl”bash
Copy code
echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add - sudo apt-get update && sudo apt-get install google-cloud-cli kubectl -y
7. Install Rust
Section titled “7. Install Rust”bash
Copy code
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh source "$HOME/.cargo/env"
8. Ensure Docker Daemon is Running
Section titled “8. Ensure Docker Daemon is Running”- Start Docker Desktop on Windows and make sure it’s running.
- In Ubuntu (WSL), check Docker:
bash
Copy code
sudo service docker start sudo usermod -aG docker $USER
Then RESTART your WSL terminal to apply group changes.
Section titled “Then RESTART your WSL terminal to apply group changes.”9. Configure WSL 2 - Follow KB00064662
Section titled “9. Configure WSL 2 - Follow KB00064662”10. Setup SSH for GitLab in WSL
Section titled “10. Setup SSH for GitLab in WSL”- Follow these instructions to generate and add your SSH key to Gitlab
bash
Copy code
ssh-keygen -t ed25519 -C "your_email@example.com" cat ~/.ssh/id_ed25519.pub # copy this and add to your GitLab account
11. Clone Phanes Repository
Section titled “11. Clone Phanes Repository”bash
Copy code
git clone git@gitlab.com:creyonbio1/tools/phanes cd phanes
Note: If you see an SSH error, troubleshoot your SSH keys and permissions with GitLab.
11. Build and Install Phanes
Section titled “11. Build and Install Phanes”bash
Copy code
make phanes make install
12. Configure Phanes
Section titled “12. Configure Phanes”Replace placeholders with your actual details.
bash
Copy code
phanes setup --username <USER_NAME> --email <EMAIL> --fullname <FULL_NAME>
Optional: If you want to specify a directory for shared data:
bash
Copy code
phanes setup --datapath <DIR> --username <USER_NAME> --email <EMAIL> --fullname <FULL_NAME>
13. Authenticate with Google Cloud
Section titled “13. Authenticate with Google Cloud”bash
Copy code
gcloud init gcloud auth configure-docker gcloud auth application-default login
- Select the relevant project (e.g., [13] prj-p-shared-base-15c0) during
gcloud init.
14. Test Phanes Installation
Section titled “14. Test Phanes Installation”bash
Copy code
phanes --help
Troubleshooting
Section titled “Troubleshooting”-
Docker-related errors
- Docker Daemon not running or permission issues
-Ensure Docker Desktop is started on Windows and running. In WSL, run
sudo usermod -aG docker $USERand restart terminal.-
gcloud/kubectlcommand not found or config errors -
PATH issues or WSL/Windows interop conflict
Edit /etc/wsl.conf in Ubuntu WSL and disable interop (see here), or uninstall duplicate Windows gcloud/kubectl if not needed.
DNS issues in Docker
-
Docker/WSL2 conflicts
- Change Docker network in
/etc/docker/daemon.jsonto use different subnet:{ "bip" : "10.10.0.1/16" }
- Change Docker network in
-
Other issues
Run export RUST_LOG=debug and retry command for more error detail.
Additional Notes
Section titled “Additional Notes”-
Always start Docker Desktop before starting Ubuntu/WSL for Phanes use.
-
If you “git pull” updates, always rebuild Phanes:
bash
Copy code
cd phanes make phanes make install -
For advanced troubleshooting, consult the full Phanes documentation or contact phanes-bugs@creyonbio.com.