Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arbarwings/remote-devpot

Remote DevPot - For a clean and fast development environment.
https://github.com/arbarwings/remote-devpot

development development-environment docker docker-compose environment

Last synced: about 2 months ago
JSON representation

Remote DevPot - For a clean and fast development environment.

Awesome Lists containing this project

README

        



Remote DevPot


Remote DevPot

For a clean and fast development environment.



Build Status


License



Intro |
Requirements |
Installation |
Usage


## Intro

Create a clean an fast development environment that is accessible from anywhere. Projects are automatically kept backuped and in sync with your OneDrive account.

Includes:

- Ubuntu 22.04 based image
- SSH
- NodeJS
- OH-MY-ZSH (with spaceship theme)
- OneDrive

## Requirements

- Docker
- Docker compose
- GitHub account
- OneDrive account

## Installation

### Linux

```sh
# Clone the repository
$ git clone https://github.com/Arbarwings/remote-devpot.git
# Navigate to the folder
$ cd remote-devpot
# Paste your SSH keys in data/ssh/ssh-keys.pub
$ mkdir data/ssh && echo "ssh-rsa ABC..." >> data/ssh/ssh-keys.pub
# Copy the example environments
$ cp .env.example .env
# Change the environment values where needed
$ nano .env
# Build the containers
$ docker compose build
# Start all the containers
$ docker compose up -d
# Connect to Remote DevPot by SSH
$ ssh root@localhost -p 1022
# Setup OneDrive and follow the instruction on screen
$ onedrive
```

### Windows

1. Install Docker Desktop
2. Install Github CLI
3. Pull this repo
4. Copy .env.example to .env and fill in the values
5. Paste your SSH keys in data/ssh/ssh-keys.pub
6. Run `docker compose build`
7. Run `docker compose up -d`
8. Connect to Remote DevPot by SSH `ssh root@localhost -p 1022`
9. Setup OneDrive and follow the instruction on screen `onedrive`

### SSH agent forwarding

To use the SSH agent forwarding, you need to add the following to your SSH config:

```sh
Host devpot.local
HostName localhost
User root
Port 1022
ForwardAgent yes
```

## Usage

### Visual Studio Code Remote

- Install the SSH plugin for VSCode: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh
- Easy to use on any computer. Just connect to the Remote DevPot SSH and start developing :)
- Ports can be easily forwarded to the local machine

### SSH

- Add SSH keys in data/ssh/ssh-keys.pub
- Available on port: 1022