Skip to content

Commit

Permalink
Enhance Docker platform specification in documentation (#6029)
Browse files Browse the repository at this point in the history
The current documentation lacks clarification on Docker platform specifications,
leading to errors when attempting to run the application on non-linux/amd64 machines.

       docker: no matching manifest for linux/arm64/v8 in the manifest list entries.

To ensure seamless execution on linux/arm architectures,
specify the appropriate platform in the Docker command line.
This adjustment aims to enhance the user experience and prevent potential issues.
  • Loading branch information
miry authored Apr 7, 2024
1 parent 4b27dbb commit 4b5795e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ If you can't find an answer, or if you want to open a package request, read [CON
cd spksrc # Go to the cloned repository's root folder.

# If running on Linux:
docker run -it -v $(pwd):/spksrc -w /spksrc ghcr.io/synocommunity/spksrc /bin/bash
docker run -it --platform=linux/amd64 -v $(pwd):/spksrc -w /spksrc ghcr.io/synocommunity/spksrc /bin/bash

# If running on macOS:
docker run -it -v $(pwd):/spksrc -w /spksrc -e TAR_CMD="fakeroot tar" ghcr.io/synocommunity/spksrc /bin/bash
docker run -it --platform=linux/amd64 -v $(pwd):/spksrc -w /spksrc -e TAR_CMD="fakeroot tar" ghcr.io/synocommunity/spksrc /bin/bash
```
5. From there, follow the instructions in the [Developers HOW TO].

Expand Down Expand Up @@ -134,7 +134,7 @@ $ lxc exec spksrc -- su --login root
# exit
```

#### (OPTIONAL) LXC: Shared `spksrc` user
#### (OPTIONAL) LXC: Shared `spksrc` user
You can create a shared user between your Debian/Ubuntu host and the LXC Debian container which simplifies greatly file management between the two. The following assumes you already created a user `spksrc` with uid 1001 in your Debian/Ubuntu host environment and that you which to share its `/home` userspace.
1. Create a mapping rule between the hosts and the LXC image:
```bash
Expand Down

0 comments on commit 4b5795e

Please sign in to comment.