Skip to content

Commit

Permalink
update docs (including addition of MAINTAINERS)
Browse files Browse the repository at this point in the history
Signed-off-by: Akihiro Suda <[email protected]>
  • Loading branch information
AkihiroSuda committed Mar 2, 2019
1 parent f30eaf1 commit 7af2f9f
Show file tree
Hide file tree
Showing 3 changed files with 174 additions and 10 deletions.
127 changes: 127 additions & 0 deletions MAINTAINERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# slirp4netns maintainers file (Moby-style TOML syntax)

[Org]

# Approvers (aka Core Maintainers) approve pull requests.
# GitHub Team: rootless-containers/slirp4netns-approvers
[Org.Approvers]
people = [
"akihirosuda",
"cyphar",
"giuseppe",
]

# Package maintainers maintain distro packages.
# GitHub Team: rootless-containers/slirp4netns-package-maintainers
[Org.PackageMaintainers]

# https://src.fedoraproject.org/rpms/slirp4netns
# https://copr.fedorainfracloud.org/coprs/vbatts/shadow-utils-newxidmap/package/slirp4netns/
[Org.PackageMaintainers.Fedora]
people = [
"giuseppe",
"lsm5",
"rhatdan",
"vbatts",
]

# https://www.archlinux.org/packages/community/x86_64/slirp4netns/
[Org.PackageMaintainers.Arch]
people = [
"barthalion",
]

# https://build.opensuse.org/package/show/openSUSE%3AFactory/slirp4netns
[Org.PackageMaintainers.openSUSE]
people = [
"cyphar",
"saschagrunert",
]

# https://packages.debian.org/buster/slirp4netns
[Org.PackageMaintainers.Debian]
people = [
"siretart",
]

# https://github.com/NixOS/nixpkgs/tree/master/pkgs/tools/networking/slirp4netns
[Org.PackageMaintainers.NixOS]
people = [
"orivej-nixos",
]

# https://packages.gentoo.org/packages/app-emulation/slirp4netns
[Org.PackageMaintainers.Gentoo]
people = [
"zmedico",
"g-braeunlich",
]

# https://git.slackbuilds.org/slackbuilds/tree/network/slirp4netns
[Org.PackageMaintainers.Slackware]
people = [
"vbatts",
]

# https://github.com/void-linux/void-packages/tree/master/srcpkgs/slirp4netns
[Org.PackageMaintainers.Void]
people = [
"cameronnemo",
]

# alphabetical order
[people]
[people.akihirosuda]
Name = "Akihiro Suda"
Email = "[email protected]"
GitHub = "AkihiroSuda"

[people.barthalion]
Name = "Bartłomiej Piotrowski"
GitHub = "barthalion"

[people.cameronnemo]
Name = "Cameron Nemo"
GitHub = "CameronNemo"

[people.cyphar]
Name = "Aleksa Sarai"
Email = "[email protected]"
GitHub = "cyphar"

[people.g-braeunlich]
Name = "Gerhard Bräunlich"
GitHub = "g-braeunlich"

[people.giuseppe]
Name = "Giuseppe Scrivano"
Email = "[email protected]"
GitHub = "giuseppe"

[people.lsm5]
Name = "Lokesh Mandvekar"
GitHub = "lsm5"

[people.rhatdan]
Name = "Daniel Walsh"
GitHub = "rhatdan"

[people.orivej-nixos]
Name = "Orivej Desh"
GitHub = "orivej-nixos"

[people.saschagrunert]
Name = "Sascha Grunert"
GitHub = "saschagrunert"

[people.siretart]
Name = "Reinhard Tartler"
GitHub = "siretart"

[people.vbatts]
Name = "Vincent Batts"
GitHub = "vbatts"

[people.zmedico]
Name = "Zac Medico"
GitHub = "zmedico"
56 changes: 46 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ slirp4netns allows connecting a network namespace to the Internet in a completel
* [Podman](https://github.com/containers/libpod)
* [Buildah](https://github.com/containers/buildah)
* [ctnr](https://github.com/mgoltzsche/ctnr) (via slirp-cni-plugin)
* [Docker & Moby](https://get.docker.com/rootless) (optionally, via RootlessKit)

* [RootlessKit](https://github.com/rootless-containers/rootlesskit)
* [become-root](https://github.com/giuseppe/become-root)
Expand Down Expand Up @@ -44,18 +45,29 @@ $ sudo make install
$ sudo dnf install slirp4netns
```

#### [Arch Linux](https://aur.archlinux.org/packages/slirp4netns/):
#### [RHEL/CentOS 7.6](https://copr.fedorainfracloud.org/coprs/vbatts/shadow-utils-newxidmap/)

If you're running Arch Linux you can install `slirp4netns` (or [`slirp4netns-git`](https://aur.archlinux.org/packages/slirp4netns-git/)) from AUR. When you're using an AUR helper ([yay](https://github.com/Jguer/yay), for example) simply use:
```console
$ sudo curl -o /etc/yum.repos.d/vbatts-shadow-utils-newxidmap-epel-7.repo https://copr.fedorainfracloud.org/coprs/vbatts/shadow-utils-newxidmap/repo/epel-7/vbatts-shadow-utils-newxidmap-epel-7.repo
$ sudo yum install slirp4netns
```

yay -S slirp4netns

Otherwise make sure you have [base-devel](https://www.archlinux.org/groups/x86_64/base-devel/) installed and build a package manually:
You might need to enable user namespaces manually:
```console
$ sudo sh -c 'echo "user.max_user_namespaces=28633" > /etc/sysctl.d/userns.conf'
$ sudo sysctl -p /etc/sysctl.d/userns.conf
```

cd $(mktemp -d)
curl -Lo PKGBUILD "https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h=slirp4netns"
makepkg
sudo pacman -U slirp4netns-*.pkg.tar.*
#### [Arch Linux](https://www.archlinux.org/packages/community/x86_64/slirp4netns/):

```console
$ sudo pacman -S slirp4netns
```

You might need to enable user namespaces manually:
```console
$ sudo sh -c "echo 1 > /proc/sys/kernel/unprivileged_userns_clone"
```

#### [openSUSE Tumbleweed](https://build.opensuse.org/package/show/openSUSE%3AFactory/slirp4netns)

Expand All @@ -77,12 +89,36 @@ $ sudo zypper addrepo --refresh http://download.opensuse.org/repositories/devel:
$ sudo zypper install slirp4netns
```

#### [Debian GNU/Linux Sid](https://packages.debian.org/sid/slirp4netns)
#### [Debian GNU/Linux (10 or later)](https://packages.debian.org/buster/slirp4netns) & [Ubuntu (19.04 or later)](https://packages.ubuntu.com/disco/slirp4netns)

```console
$ sudo apt install slirp4netns
```

#### [NixOS](https://github.com/NixOS/nixpkgs/tree/master/pkgs/tools/networking/slirp4netns)

```console
$ nix-env -i slirp4netns
```

#### [Gentoo Linux](https://packages.gentoo.org/packages/app-emulation/slirp4netns)

```console
$ sudo emerge app-emulation/slirp4netns
```

#### [Slackware](https://git.slackbuilds.org/slackbuilds/tree/network/slirp4netns)

```console
$ sudo sbopkg -i slirp4netns
```

#### [Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/slirp4netns)

```console
$ sudo xbps-install slirp4netns
```

### Usage

Terminal 1: Create user/network/mount namespaces
Expand Down
1 change: 1 addition & 0 deletions SECURITY_CONTACTS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
If you found a security issue of slirp4netns, please make a contact to "Approvers" (aka Core Maintainers) listed in the `MAINTAINERS` file privately.

0 comments on commit 7af2f9f

Please sign in to comment.