Mario1159/osic-stacks
1
1
Fork 1
Code Issues 11 Pull Requests Actions Packages Projects 2 Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Mario Romero 2023-09-28 23:35:36 -03:00
parent 62d751c249
commit faae78cc5d
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -29,7 +29,7 @@ include_toc: true
- **digital-heavy**: Workflow with all the digital tools
- **heavy**: Workflow with all the previous tools
> Flavors: web / desktop
> Flavors: Web / Desktop | [Docker image list](https://git.1159.cl/Mario1159/osic-stacks/packages)
## Usage
@ -55,7 +55,7 @@ Execute the next script in powershell and follow the container initialization pr
This script will run the container inside WSL and bind the enviroments variables for [WSLg](https://github.com/microsoft/wslg/blob/main/samples/container/Containers.md).
##### Linux
Execute the next script in your terminal replacing `<container_name>` by any name and `<stack>` by an stack from the previous [stack list](#stacks).
Execute the next docker command in your terminal replacing `<container_name>` by any name and `<stack>` by an stack from the previous [stack list](#stacks).
```sh
docker run -it -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix --name <container_name> git.1159.cl/mario1159/<stack>-desktop
```
@ -69,8 +69,9 @@ Install `Xquartz` and run the linux previous command.
#### 1b. Starting a container with a **Web** VNC client
If you prefer running the container in your web browser instead of in your integrated terminal, you can select the web flavor of any stack. In this case, it is not necessary to bind extra environment variables for enabling native graphics output.
```sh
docker run -it -p 8444:8444 --name <container_name> git.1159.cl/mario1159/<stack>-web
docker run -d --security-opt seccomp=unconfined -p 8444:8444 --name <container_name> git.1159.cl/mario1159/<stack>-web
```
This can also be deployed from a docker compose file, an example is provided [here](https://git.1159.cl/Mario1159/osic-stacks/src/branch/main/compose/docker-compose.yml).
### 2. Connecting to the container
@ -86,6 +87,8 @@ docker exec -it <container_name> bash
Access from the web to the VNC client at `https://localhost:8444`.
The default username is `designer` and the password is `password`.
### 3. Configure Volare
List the available PDKs and choose one to install.
@ -100,7 +103,8 @@ List the available PDKs and choose one to install.
Replace `<pdk_variant>` and `<pdk_tech>` correspondingly by one of the PDKs listed above.
```sh
echo 'export PDK=<pdk_variant>' >> ~/.bashrc
export PDK=<pdk_variant>
echo 'export PDK=${PDK}' >> ~/.bashrc
volare ls-remote --pdk <pdk_tech>
volare enable --pdk <pdk_tech> <version_id>
```