ahill/shadow
1
0
Fork 0
mirror of https://github.com/shadow-maint/shadow.git synced 2026-01-26 14:03:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
shadow/doc/contributions/build_install.md
Tobias Stoeckmann 876e874684 Fix documentation style 
Always start a sentence with lowercase letter after 'Note:', 'Warning:',
etc. This unifies all occurrences.

No functional change.

Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org>
2025-12-19 16:48:08 +01:00

3.0 KiB
Raw Permalink Blame History

Build & install

The following page explains how to build and install the shadow project. Additional information on how to do this in a container environment is provided at the end of the page.

Local

Dependency installation

This projects depends on other software packages that need to be installed before building it. We recommend using the dependency installation commands provided by the distributions to install them. Some examples below.

Debian:

apt-get build-dep shadow

Fedora:

dnf builddep shadow-utils

An alternative would be to take a look at the CI workflow file and get the package names from there. This has the advantage that it also includes new dependencies needed for the development version which might have not been present in the last release.

Configure

The first step is to configure it. You can use the autogen.sh script provided by the project. Example:

./autogen.sh --without-selinux --enable-man --with-yescrypt

Build

The next step is to build the project:

make -j4

Install

The last step is to install it. We recommend avoiding this step and using a disposable system like a VM or a container instead.

make install

Containers

Alternatively, you can use any of the preconfigured container images builders to build and install shadow.

You can either generate a single image by running the following command from the root folder of the project (i.e. Alpine):

ansible-playbook share/ansible/playbook.yml -i share/ansible/inventory.ini -e 'distribution=alpine'

Note: you'll need to install ansible to run this automation.

Or generate all of the images with the container-build.sh script, as if you were running some of the CI checks locally:

share/container-build.sh

Container troubleshooting

When working with containers for testing or development, you may encounter issues. Here are common troubleshooting steps:

Post-test inspection:

  • Container persistence: after tests complete, containers are left running to allow inspection of the test environment and debugging of any failures. This enables you to examine logs, file states, and system configuration that existed when tests ran.

Container management:

  • List containers: docker ps -a to see all containers and their status.
  • Access container: docker exec -it <container-name> bash to get shell access.
  • Container logs: docker logs <container-name> to view container output.
  • Remove containers: docker rm <container-name> to clean up stopped containers.

Common issues:

  • Container not found: ensure you've run the Ansible playbook to create the required containers.
  • Permission issues: verify the container has proper privileges for user/group operations.
  • Network connectivity: check that containers can communicate if tests involve network operations.
  • Resource constraints: ensure sufficient disk space and memory for container operations.