Skip to content
Snippets Groups Projects
Commit d66d5be4 authored by Moul's avatar Moul
Browse files

Use content tabs on container usage doc (#433)

podman/sudo docker
Rename file
parent dd906fe9
No related branches found
No related tags found
1 merge request!271Set up new website structure with MkDocs (#433)
...@@ -104,7 +104,7 @@ If you missed DeathReaper crowdfunding completion, you can check this [message]( ...@@ -104,7 +104,7 @@ If you missed DeathReaper crowdfunding completion, you can check this [message](
The automated generation of Silkaj Docker images has been implemented in the first place to distribute DeathReaper. The automated generation of Silkaj Docker images has been implemented in the first place to distribute DeathReaper.
This is a new way to install Silkaj and its environment. This is convenient to distribute non-stable releases. This is a new way to install Silkaj and its environment. This is convenient to distribute non-stable releases.
You can find the [documentation on how to use these images](/docker). You can find the [documentation on how to use these images](/container_usage).
## Network ## Network
......
...@@ -24,7 +24,7 @@ To install the Python package, run following command: ...@@ -24,7 +24,7 @@ To install the Python package, run following command:
pip3 install silkaj --user --upgrade --pre pip3 install silkaj --user --upgrade --pre
``` ```
To [install and run Silkaj from the Docker image](/docker): To [install and run Silkaj from a container](/container_usage):
``` ```
sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0 sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.10.0rc0
......
...@@ -29,7 +29,7 @@ sudo apt install pipx ...@@ -29,7 +29,7 @@ sudo apt install pipx
pipx install --pip-args "\--pre" silkaj pipx install --pip-args "\--pre" silkaj
``` ```
To [install and run Silkaj from the Docker image](/docker): To [install and run Silkaj from the container](/container_usage):
``` ```
sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0 sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:v0.11.0rc0
......
### Docker images There are two kind of containers. The one built with `pip` for user purposes, and the one built with Poetry for developer purposes.
There are two kind of images. The one built with `pip` for user purposes, and the one built with Poetry for developer purposes. We recommand using `podman` instead of `docker` command for not having to run the command as `root`.
We are using `podman` instead of `docker` command for not having to run the command as `root`.
In case you use `docker`, you can [add your user into the `docker` group, so you can manipulate `docker` executable without `root` permissions](https://askubuntu.com/a/739861). In case you use `docker`, you can [add your user into the `docker` group, so you can manipulate `docker` executable without `root` permissions](https://askubuntu.com/a/739861).
Feel free to replace `podman` with `sudo docker`.
#### User #### User
Pull the image: Pull the image:
```bash === "Podman"
podman pull registry.duniter.org/clients/python/silkaj/release/pip:latest ```
``` podman pull registry.duniter.org/clients/python/silkaj/release/pip:latest
```
=== "Docker"
```
sudo docker pull registry.duniter.org/clients/python/silkaj/release/pip:latest
```
Run Silkaj from outside the image: Run Silkaj from outside the image:
```bash === "Podman"
podman run -it registry.duniter.org/clients/python/silkaj/release/pip:latest silkaj info ```
``` podman run -it registry.duniter.org/clients/python/silkaj/release/pip:latest silkaj info
```
Go into the image, then run Silkaj: === "Docker"
```
sudo docker run -it registry.duniter.org/clients/python/silkaj/release/pip:latest silkaj info
```
```bash Go into the image:
podman run -it registry.duniter.org/clients/python/silkaj/release/pip:latest bash
=== "Podman"
```
podman run -it registry.duniter.org/clients/python/silkaj/release/pip:latest bash
```
=== "Docker"
```
sudo docker run -it registry.duniter.org/clients/python/silkaj/release/pip:latest bash
```
Then run Silkaj:
```
silkaj info silkaj info
``` ```
...@@ -38,20 +57,43 @@ This is fine for doing small editions. For bigger editions, it is adviced to use ...@@ -38,20 +57,43 @@ This is fine for doing small editions. For bigger editions, it is adviced to use
Pull the image: Pull the image:
```bash === "Podman"
podman pull registry.duniter.org/clients/python/silkaj/release/poetry:latest ```
``` podman pull registry.duniter.org/clients/python/silkaj/release/poetry:latest
```
=== "Docker"
```
sudo docker pull registry.duniter.org/clients/python/silkaj/release/poetry:latest
```
Run Silkaj from ouside the image: Run Silkaj from ouside the image:
```bash === "Podman"
podman run -it registry.duniter.org/clients/python/silkaj/release/poetry:latest silkaj info ```
``` podman run -it registry.duniter.org/clients/python/silkaj/release/poetry:latest silkaj info
```
Go into the image, then run Silkaj: === "Docker"
```
sudo docker run -it registry.duniter.org/clients/python/silkaj/release/poetry:latest silkaj info
```
```bash Go into the image:
podman run -it registry.duniter.org/clients/python/silkaj/release/poetry:latest bash
=== "Podman"
```
podman run -it registry.duniter.org/clients/python/silkaj/release/poetry:latest bash
```
=== "Docker"
```
sudo docker run -it registry.duniter.org/clients/python/silkaj/release/poetry:latest bash
```
Then run Silkaj:
```
silkaj info silkaj info
``` ```
......
...@@ -57,7 +57,7 @@ nav: ...@@ -57,7 +57,7 @@ nav:
- Contributing: - Contributing:
- contributing.md - contributing.md
- Poetry installation: install_poetry.md - Poetry installation: install_poetry.md
- Docker installation: docker.md - Container usage: container_usage.md
- Documentation: documentation.md - Documentation: documentation.md
- Testing: testing.md - Testing: testing.md
- Coverage report: coverage.md - Coverage report: coverage.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment