☁️ NeoVim Server

A containerized IDE-like text editor that runs on a web server

This tool is for running NeoVim remotely and continuing the development process at 🚀 speed. You can use it to implement an IDE-like web-based terminal text editor.

✨ Features

• Portable and light-weight
• Easy to deploy
• Versatile and customizable
• Containerized
• Run on a web browser
• Build with multi-arch (arm64/amd64)

Prerequisites

• Driod Sans Mono Nerd Font is required to be downloaded since its the default font of the container. You may find the installation guide below. To use other fonts, please find the instructions on the Nerd Font repository.
• Choose a web browser in your preference. Google Chrome, Microsoft Edge, and FireFox should work fine, whereas Safari does not work temporarily.

Font Installation

Notes: reboot might be needed after the font installation

Linux

mkdir -p ~/.local/share/fonts
cd ~/.local/share/fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20Nerd%20Font%20Complete.otf

macOS

cd ~/Library/Fonts && curl -fLo "Droid Sans Mono for Powerline Nerd Font Complete.otf" https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/DroidSansMono/complete/Droid%20Sans%20Mono%20Nerd%20Font%20Complete.otf

Arch User ONLY

yay -S nerd-fonts-droid-sans-mono

📥 Installation

Run with the pre-built image

docker run -d \
  --name nvim-server \
  -p 6080:3000 \
  -p 8090:8090 \
  -v ~/workspace:/workspace \
  -v /appdata/nvim-server:/config \
  -e TZ=Asia/Shanghai \
  -e USER=<USER> \
  -e SECRET=<PASSWORD> \
  hikariai/nvim-server:latest

Notes:

• Wait for a couple seconds until the container finishes its bootstrap process, then visit http://localhost:6080/wetty
• You may check the log by running docker logs nvim-server

Parameters	Usage
name	Name for the container
6080	Web UI
8090	Instant Markdown Preview Server
/workspace	Working directory
/config	Config directory
TZ	Timezone
USER	Username for login
SECRET	Password for login

Build the image manually

Follow the instruction HERE

UNRAID User ONLY

Coming soon, please stay tuned!

💡 Usage

• After logging in with username and password in the web console, type vim to finish the initial setup.

• For the first launch, NeoVim will install the coc-extensions defined in coc.settings. You may also download additional coc-extensions followed by the instructions

• All the functionalities and usage cases are written in the Wiki Page, feel free to check it out.

• To get familiar with the default key mappings, please visit the Cheat Sheet Page

📋 Wiki

• Wiki (EN)

💬F.A.Q

• F.A.Q (EN)

TODO

• Add a customizable base image
• Add more customizable features
• Add more advanced usage cases

Reference

• wetty repository
• neovim repository
• coc-nvim repository

License

MIT (C) Kevin Yu