-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
61 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,44 +2,46 @@ | |
|
||
## Local development environment | ||
|
||
1) Install `git`, `make`, `curl`, and `docker` | ||
```sh | ||
sudo apt install git make curl | ||
curl -sSL https://get.docker.com | sh && sudo usermod -aG docker $USER | ||
``` | ||
and reboot the PC. | ||
2) Clone this repository | ||
```sh | ||
# Make sure to have your SSH keys added to GitHub | ||
git clone [email protected]:memristor/mep3.git | ||
``` | ||
|
||
3) Run provisioning script to pull the image and run the container: | ||
1. Install `git`, `make`, `curl`, and `docker` | ||
```sh | ||
sudo apt install git make curl | ||
curl -sSL https://get.docker.com | sh && sudo usermod -aG docker $USER | ||
``` | ||
and reboot the PC. | ||
2. Clone this repository | ||
|
||
```sh | ||
# Make sure to have your SSH keys added to GitHub | ||
git clone [email protected]:memristor/mep3.git | ||
``` | ||
|
||
3. Run provisioning script to pull the image and run the container: | ||
|
||
```sh | ||
cd ./mep3/docker | ||
make run | ||
make all | ||
``` | ||
|
||
> Time to time you can run `make destroy run` to get the newest packages. | ||
4) Wait for the provisioning script to finish | ||
4. Wait for the provisioning script to finish | ||
|
||
5) _Optional:_ run container setup script | ||
```sh | ||
make setup-default | ||
5. _Optional:_ run interactive setup if you prefer to manually configure the container | ||
|
||
# If you prefer to manually configure setup, you can just do make setup and go through the prompts | ||
make setup-interactive | ||
``` | ||
6) Acces the environment from any terminal window | ||
```sh | ||
docker exec -it mep3-devel bash | ||
``` | ||
Graphical applications started inside this terminal will use your existing Xorg session to display. | ||
```sh | ||
make setup-interactive | ||
``` | ||
|
||
6. Acces the environment from any terminal window | ||
```sh | ||
docker exec -it mep3-devel bash | ||
``` | ||
Graphical applications started inside this terminal will use your existing Xorg session to display. | ||
|
||
## Code Server | ||
|
||
If you prefer to use browser based VS Code, you can start it in the container and then access it locally through your browser at `localhost:31415` | ||
|
||
```sh | ||
# This will start the VS code server with your mep3 repo | ||
make start-code-server | ||
|
@@ -50,20 +52,20 @@ make stop-code-server | |
|
||
## Remote development environment (VNC) | ||
|
||
|
||
|
||
1) Follow steps in [Local development environment](#local-development-environment), but add `vnc` after | ||
1. Follow steps in [Local development environment](#local-development-environment), but add `vnc` after | ||
`make` in steps 4 and 6 (eg. `make vnc setup`) | ||
2) Enable VNC preferences in step 6 and wait for the container to restart | ||
3) Web-based VNC client will be accessible at `http://localhost:6810/` if you keep default noVNC webserver port | ||
4) In step 6 replace `mep3-devel` with `mep3-vnc` | ||
2. Enable VNC preferences in step 6 and wait for the container to restart | ||
3. Web-based VNC client will be accessible at `http://localhost:6810/` if you keep default noVNC webserver port | ||
4. In step 6 replace `mep3-devel` with `mep3-vnc` | ||
|
||
**Note:** If you are setting up through SSH, make sure to have a running Xorg server on host machine, | ||
and set `DISPLAY` environment variable on step 4 to its value (eg `:0`). | ||
|
||
```sh | ||
export DISPLAY=:0 | ||
``` | ||
|
||
## NVIDIA GPU | ||
|
||
If you happen to have NVIDIA GPUs that you wish to use within these development environments, make sure | ||
to have NVIDIA Container Toolkit installed on your system. More info, specific to your distribution [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters