Firejail Build Chroot

Initializes new chroot file systems compatible with Firejail sandboxing utility

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

  • Clone
  • Install
  • Uninstall
  • Upgrade

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

This project in intended to be used with Firejail, ensure that Firejail is available, of version 0.9.63 or greater, and has chroot support enabled...

firejail --version
#> firejail version 0.9.63
#>
#> Compile time support:
#> ...
#>         - chroot support is enabled
#> ...

---

This repository makes use of Git Submodules to track script dependencies, to avoid incomplete downloads clone with the --recurse-submodules option.

---

Quick Start

Perhaps as easy as one, 2.0,...

Clone

If utilizing the project on a multi-user device then clone with sudo/root level permissions...

cd /usr/local/etc

sudo git clone --recurse-submodules git@github.com:paranoid-linux/build-firejail-chroot.git

Note, if installing system-wide then upgrade, and uninstall Makescript targets will require sudo/root level permissions too.

Else if using this project on a single-user device, then it should be okay to clone to a user home directory path...

mkdir ~/git/hub/paranoid-linux

cd ~/git/hub/paranoid-linux

git clone --recurse-submodules git@github.com:paranoid-linux/build-firejail-chroot.git

---

Install

After cloning this repository run the Makefile script to symbolically link the project script...

cd ~/git/hub/paranoid-linux/build-firejail-chroot

make install

---

Uninstall

To remove symbolic links run the uninstall make target...

cd ~/git/hub/paranoid-linux/build-firejail-chroot

make uninstall

---

Upgrade

Run the upgrade make target to update this project...

cd ~/git/hub/paranoid-linux/build-firejail-chroot

make upgrade

---

Usage

Print available command line parameters via --help or -h option...

build-firejail-chroot.sh --help

Build a chroot file system based on Debian (accepts defaults)...

sudo build-firejail-chroot.sh --mount-name debian jailed_server

Mount/start Firejailed chroot shell session with mount script...

jailed_debian.sh

... or run command within Firejail chroot session...

jailed_debian.sh ls -ahl /home

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

---

Run project script with -h or --help option to list available parameters and currently set values...

build-firejail-chroot -h

---

To show available make command options run with list option...

make list

---

Contributing

Options for contributing to build-firejail-chroot and paranoid-linux

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...

cd ~/git/hub/paranoid-linux/build-firejail-chroot

git remote add fork git@github.com:<NAME>/build-firejail-chroot.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/paranoid-linux/build-firejail-chroot


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as build-firejail-chroot that paranoid-linux maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• GitHub -- github-utilities/make-readme

---

License

Initializes new chroot file systems compatible with Firejail sandboxing utility
Copyright (C) 2020 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.