Univention Corporate Server

https://docs.software-univention.de/developer-reference/latest/en/
Admin
Univention Corporate Server (UCS) is an operating system for server infrastructures, providing tools...
Tokens:181,825
Snippets:595
Trust Score:5.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### debian/testdeb.install File Example

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Specifies which files should be installed and where they should be placed in the target system. This entry installs the `testdeb.py` script into `/usr/bin/`.

```text
testdeb.py usr/bin/

```

--------------------------------

### debian/testdeb.postinst Script Example

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

A post-installation script that runs after the package is installed. It can execute commands, set configuration variables (like UCR variables), and handle different installation scenarios.

```shell
#! /bin/sh
set -e

case "$1" in
configure)
	# invoke sample program
	testdeb.py
	# Set UCR variable if previously unset
	ucr set repository/online/server?https://updates.software-univention.de/
	# Force UCR variable on upgrade from previous package only
	if dpkg --compare-versions "$2" lt-nl 0.1-2
	then
		ucr set timeserver1=time.fu-berlin.de
	fi
	;;
abort-upgrade|abort-remove|abort-deconfigure)
	;;
*)
	echo "postinst called with unknown argument \`$1'" >&2
	exit 1
	;;
esac

#DEBHELPER#

exit 0

```

--------------------------------

### Post-installation script to set atd/autostart UCRV

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/ucr/examples

A Debian post-installation script snippet that sets the `atd/autostart` UCRV to 'yes' during package configuration. This ensures the `atd` daemon is automatically started on new installations.

```bash
#!/bin/sh

case "$1" in
configure)
	ucr set atd/autostart?yes
	;;
esac

#DEBHELPER#

exit 0
```

--------------------------------

### Configure printusers.postinst Script

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/listener/tasks-examples

This bash script handles post-installation configuration for the printusers package. It ensures the univention-directory-listener service is restarted after package installation to apply module changes.

```bash
#!/bin/sh
set -e

case "$1" in
configure)
    deb-systemd-invoke restart univention-directory-listener
    ;; 
abort-upgrade|abort-remove|abort-deconfigure)
    ;; 
*)
    echo "postinst called with unknown argument \`$1'" >&2
    exit 1
    ;; 
esac

#DEBHELPER#

exit 0
```

--------------------------------

### Basic Univention Join Script Example

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/join/write-join

A template for Univention join scripts demonstrating initialization, service registration, and UDM command usage for directory modifications. It includes essential setup and error handling for Univention directory operations.

```bash
#!/bin/sh

## joinscript api: bindpwdfile

VERSION=1
. /usr/share/univention-join/joinscripthelper.lib
joinscript_init

SERVICE="MyService"

eval "$(ucr shell)"

. /usr/share/univention-lib/ldap.sh
ucs_addServiceToLocalhost "$SERVICE" "$@" || die

. /usr/share/univention-lib/ldap.sh
ucs_addServiceToLocalhost "$SERVICE" "$@" || die

udm "computers/$server_role" modify "$@" \
    --dn "$ldap_hostdn" \
    --set reinstall=0 || die

# create container for extended attributes to be placed in
udm container/cn create "$@" \
    --ignore_exists \
    --position "cn=custom attributes,cn=univention,$ldap_base" \
    --set name="myservice" || die

# some extended attributes would be added here

joinscript_save_current_version
exit 0

```

--------------------------------

### Install printusers.py Module

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/listener/tasks-examples

Specifies the installation path for the printusers.py module within the Debian packaging context. It indicates that the module should be placed in the /usr/lib/univention-directory-listener/system/ directory.

```text
printusers.py usr/lib/univention-directory-listener/system/
```

--------------------------------

### Setup UCS APT Repository with Shell Commands

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

This snippet demonstrates the shell commands required to create a local APT repository for Univention Corporate Server (UCS) packages. It involves creating directories, copying .deb files, and generating package index files using `apt-ftparchive`. Ensure `apache2` is installed for HTTP access.

```shell
$ WWW_BASE="/var/www/repository/5.2/maintained/component"
$ TESTCOMP="testcomp/all"
$ install -m755 -d "$WWW_BASE/$TESTCOMP"
$ install -m644 -t "$WWW_BASE/$TESTCOMP" *.deb
$ ( cd "$WWW_BASE"
  rm -f "$TESTCOMP/Packages"*
  apt-ftparchive packages "$TESTCOMP" > "Packages"
  gzip -9 < "Packages" > "$TESTCOMP/Packages.gz"
  mv "Packages" "$TESTCOMP/Packages" )
```

--------------------------------

### Bash init script for atd service with UCRV integration

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/ucr/examples

An example init script for the `atd` service that checks the `atd/autostart` UCRV to control daemon startup. It includes standard init script headers, LSB functions, and logic for starting, stopping, and checking the status of the `atd` daemon.

```bash
#! /bin/sh
@%@UCRWARNING=# @%@
### BEGIN INIT INFO
# Provides:          atd
# Required-Start:    $syslog $time $remote_fs
# Required-Stop:     $syslog $time $remote_fs
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: Deferred execution scheduler
# Description:       Debian init script for the atd deferred executions
#                    scheduler
### END INIT INFO
# pidfile: /var/run/atd.pid
#
# Author:	Ryan Murray <rmurray@debian.org>
#

PATH=/bin:/usr/bin:/sbin:/usr/sbin
DAEMON=/usr/sbin/atd
PIDFILE=/var/run/atd.pid

test -x "$DAEMON" || exit 0

. /lib/lsb/init-functions

case "$1" in
  start)
  	log_daemon_msg "Starting deferred execution scheduler" "atd"
  	start_daemon -p "$PIDFILE" "$DAEMON"
  	log_end_msg $?
    ;;
  stop)
  	log_daemon_msg "Stopping deferred execution scheduler" "atd"
  	killproc -p "$PIDFILE" "$DAEMON"
  	log_end_msg $?
    ;;
  force-reload|restart)
    "$0" stop
    "$0" start
    ;;
  status)
    status_of_proc -p "$PIDFILE" "$DAEMON" atd && exit 0 || exit $?
    ;;
  *)
    echo "Usage: $0 {start|stop|restart|force-reload|status}"
    exit 1
    ;;
esac

exit 0
```

--------------------------------

### Install New Binary Package

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Installs the newly built binary Debian package locally using apt-get.

```console
$ sudo apt-get install ../univention-ssh_*_*.deb
```

--------------------------------

### Univention Configuration Registry (UCR) Examples

Source: https://docs.software-univention.de/developer-reference/latest/en/genindex

Provides examples and references for using the Univention Configuration Registry (UCR) for managing system configurations. Includes examples for single file, multi-file, and service configurations.

```APIDOC
ucr/examples.html#index-0
ucr/examples.html#index-1
ucr/examples.html#index-4
ucr/examples.html#index-8
```

--------------------------------

### UCR Configuration and Examples

Source: https://docs.software-univention.de/developer-reference/latest/en/genindex

Documentation for Univention Configuration Registry (UCR) settings, including examples for services and single files.

```APIDOC
script/template
  - Description: Refers to template files used for scripts within UCR.
  - Example: Not available.

services/examples
  - Description: Examples of UCR configurations for various services.
  - Example: Not available.

single file/examples
  - Description: Examples of UCR configurations for managing single files.
  - Example: Not available.

single file/template
  - Description: Template files used for single file configurations in UCR.
  - Example: Not available.

print/papersize
  - Description: UCR setting related to print paper sizes.
  - Example: Not available.
```

--------------------------------

### Service Post-Installation Script

Source: https://docs.software-univention.de/developer-reference/latest/en/ucr/examples

This shell script is executed after package configuration. It sets the 'atd/autostart' Univention Configuration Registry Variable to 'yes' by default, ensuring the AT daemon is automatically started on new installations.

```shell
#!/bin/sh

case "$1" in
configure)
  ucr set atd/autostart?yes
  ;;
esac

#DEBHELPER#

exit 0

```

--------------------------------

### Install Debian Package Command

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Demonstrates how to manually install a Debian package file using the dpkg command. This is typically done for local installations or when APT is not available.

```shell
dpkg -i ../testdeb_0.1-2_all.deb
```

--------------------------------

### Manual Debian Package Installation

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Demonstrates the command to manually install a compiled Debian package file (`.deb`) on a system. This is typically done from the command line using `dpkg -i`.

```bash
dpkg -i ../testdeb_0.1-2_all.deb

```

--------------------------------

### Debian Control File Example

Source: https://docs.software-univention.de/developer-reference/latest/en/appendix/debian-packaging

An example of the initial debian/control file structure generated by dh_make, showing both source and package definitions.

```debian
Source: testdeb
Section: unknown
Priority: optional
Maintainer: John Doe <user@example.com>
Build-Depends: debhelper (>= 5.0.0)
Standards-Version: 3.7.2

Package: testdeb
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: <insert up to 60 chars description>
<insert long description, indented with spaces>

```

--------------------------------

### UDM Objects Configuration Example

Source: https://docs.software-univention.de/developer-reference/latest/en/udm/syntax

Example demonstrating how to define a UDM object class to list servers providing a specific service. It specifies the UDM modules to use and the label for displayed entries.

```python
class MyServers(UDM_Objects):
    udm_modules = (
        'computers/domaincontroller_master',
        'computers/domaincontroller_backup',
        'computers/domaincontroller_slave',
        'computers/memberserver',
        )
    label = '%(fqdn)s'
    udm_filter = 'service=MyService'
```

--------------------------------

### Debian Control File Example

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/appendix/debian-packaging

An example of the debian/control file format, which contains information about packages and their dependencies required by dpkg.

```debian
Source: testdeb
Section: unknown
Priority: optional
Maintainer: John Doe <user@example.com>
Build-Depends: debhelper (>= 5.0.0)
Standards-Version: 3.7.2

Package: testdeb
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: <insert up to 60 chars description>
<insert long description, indented with spaces>
```

--------------------------------

### Python Example: MyServers List

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/udm/syntax

An example Python class for UDM_Objects, listing servers from multiple UDM modules, defining the label format, and applying a UDM filter for specific services.

```python
class MyServers(UDM_Objects):
    udm_modules = (
        'computers/domaincontroller_master',
        'computers/domaincontroller_backup',
        'computers/domaincontroller_slave',
        'computers/memberserver',
        )
    label = '%(fqdn)s'
    udm_filter = 'service=MyService'
```

--------------------------------

### Install Prerequisites on Non-UCS Machine (Ubuntu)

Source: https://docs.software-univention.de/developer-reference/latest/en/translation/package

Installs essential development tools like Git, Python 3.7+, and pip on a non-UCS machine, specifically demonstrated for Ubuntu 20.04. These are required before cloning the UCS repository and installing the l10n package.

```shell
$ sudo apt-get install git python3 python3-pip
```

--------------------------------

### Install Development Packages

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Installs necessary packages for software packaging development, including git, build-essential, and devscripts.

```console
$ sudo apt-get install git build-essential devscripts
```

--------------------------------

### Install Local Binary Package

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Installs the newly built binary Debian package into the local system using apt-get. The package is located in the parent directory relative to the current working directory.

```shell
sudo apt-get install ../univention-ssh_*_*.deb
```

--------------------------------

### Install Development Packages

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Installs essential packages required for building software on a development system, including git for version control, build-essential for compilation tools, and devscripts for package maintenance utilities.

```shell
sudo apt-get install git build-essential devscripts
```

--------------------------------

### debian/rules File Example

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

A Makefile that controls the package build process. This example uses the default `dh $@` command, which automatically invokes the appropriate debhelper sequence.

```makefile
#!/usr/bin/make -f
%:
	dh $@

```

--------------------------------

### Debian Package Build Process Output

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Example output from the `dpkg-buildpackage` command, detailing the steps involved in cleaning, building, and packaging the software. It shows the creation of source archives and the final binary package.

```text
dpkg-buildpackage: info: source package testdeb
dpkg-buildpackage: info: source version 0.1-1
dpkg-buildpackage: info: source distribution unstable
dpkg-buildpackage: info: source changed by John Doe <user@example.com>
dpkg-buildpackage: info: host architecture amd64
 dpkg-source --before-build .
 debian/rules clean
dh clean
   dh_clean
dpkg-source -b .
dpkg-source: info: using source format '1.0'
dpkg-source: warning: source directory 'testdeb' is not <sourcepackage>-<upstreamversion> 'testdeb-0.1'
dpkg-source: info: building testdeb in testdeb_0.1-1.tar.gz
dpkg-source: info: building testdeb in testdeb_0.1-1.dsc
 debian/rules build
dh build
   dh_update_autotools_config
   dh_autoreconf
   create-stamp debian/debhelper-build-stamp
debian/rules binary
dh binary
   dh_testroot
   dh_prep
   dh_install
   dh_installdocs
   dh_installchangelogs
   dh_perl
   dh_link
   dh_strip_nondeterminism
   dh_compress
   dh_fixperms
   dh_missing
   dh_installdeb
   dh_gencontrol
   dh_md5sums
   dh_builddeb
dpkg-deb: building package 'testdeb' in '../testdeb_0.1-1_all.deb'.
 dpkg-genbuildinfo
 dpkg-genchanges  >../testdeb_0.1-1_amd64.changes
dpkg-genchanges: info: including full source code in upload
 dpkg-source --after-build .
dpkg-buildpackage: info: full upload; Debian-native package (full source is included)

```

--------------------------------

### Default Packages for Component Installation

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/repositories

Defines a list of package names, separated by blanks, that are considered default for a component. The UMC module 'Repository Settings' uses this list to offer component installation if any of the listed packages are not yet installed, simplifying subsequent component setup.

```APIDOC
.. envvar:: repository/online/component/NAME/defaultpackages

   Defines a list of package names separated by blanks. The UMC module *Repository Settings* offers the installation of this component if at least one of the packages isn't installed. Specifying the package list eases the subsequent installation of components.
```

--------------------------------

### Downloading Univention Directory Manager Sample Code

Source: https://docs.software-univention.de/developer-reference/latest/en/udm/udm-modules

Provides information on accessing the latest sample code for Univention Directory Manager (UDM) modules. It points to a GitHub repository and explains the contents of the source package, including binary packages and an example script.

```text
The latest version of the sample code can be found at
[UCS source: packaging/univention-directory-manager-module-example/](https://github.com/univention/univention-corporate-server/tree/5.2-1/packaging/univention-directory-manager-module-example/).

It contains a source package in Debian format from which two binary packages are
created during package building through **./debian/rules binary**: A schema
package that needs to be installed on the master and the package containing the
UDM module itself. The sample code also includes a script
**ip-phone-tool**, which exemplifies the use of the UDM Python API in a
Python script.
```

--------------------------------

### Install Translation Development Tools

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/translation/umc

Installs the necessary Debian development tools and Git for creating translation packages. This command ensures all prerequisites are met before starting the translation process.

```console
$ sudo univention-install univention-l10n-dev dpkg-dev git
```

--------------------------------

### Debian Rules File for Univention Join Script Installation

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/join/write-join

Example debian/rules file demonstrating how to integrate Univention's build tools. It shows the use of `dh $@ --with univention-join` to ensure join scripts are correctly installed during the package build process.

```makefile
#!/usr/bin/make -f
%:
	dh $@ --with univention-join

```

--------------------------------

### Enable Source Repository and Update

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Enables online source repositories for APT and updates the package list.

```console
$ sudo ucr set repository/online/sources=yes
$ sudo apt-get update
```

--------------------------------

### Get UCR Variable from Shell

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/ucr/usage

Illustrates retrieving the current value of a Univention Configuration Registry (UCR) variable from the shell. It includes an example of using the retrieved value in a conditional statement.

```bash
case "$(ucr get system/role)" in
    domaincontroller_*) 
        echo "Running on a UCS Directory Node"
        ;;
esac
```

--------------------------------

### Debian Packaging: printusers.postinst

Source: https://docs.software-univention.de/developer-reference/latest/en/listener/tasks-examples

A post-installation script for the Debian package that ensures the Univention Directory Listener service is restarted after the package is installed or removed.

```Shell
#!/bin/sh
set -e

```

--------------------------------

### Get Integer UCR Values in Python

Source: https://docs.software-univention.de/developer-reference/latest/en/ucr/usage

Shows how to retrieve integer values from Univention Configuration Registry (UCR) variables using the `ucr.get_int` method. It includes examples of retrieving a value and retrieving a value with a default if the key is not found.

```python
from univention.config_registry import ucr
print(ucr.get_int("key"))
print(ucr.get_int("key", 10))
```

--------------------------------

### UCR - Minimal File Configuration (papersize)

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/ucr/examples

Demonstrates a minimal Univention Config Registry setup for managing a single configuration file, /etc/papersize. It shows how to register a UCR variable and configure its default value.

```text
@%@print/papersize@%@
```

```text
Type: file
File: etc/papersize
```

```ini
[print/papersize]
Description[en]=specify preferred paper size [a4]
Description[de]=Legt die bevorzugte Papiergröße fest [a4]
Type=str
Categories=service-cups
```

```bash
#!/bin/sh

case "$1" in
configure)
	ucr set print/papersize?a4
	;;
esac

#DEBHELPER#

exit 0
```

```makefile
#!/usr/bin/make -f
%:
	dh $@ --with ucr
```

```text
Source: papersize
Section: univention
Priority: optional
Maintainer: Univention GmbH <packages@univention.de>
Build-Depends:
 debhelper-compat (= 13),
 univention-config-dev (>= 15.0.3),
Standards-Version: 4.3.0.3

Package: papersize
Architecture: all
Depends: ${misc:Depends}
Description: An example package to configure the papersize
 This purpose of this package is to show how Univention Config
 Registry is used.
 .
 For more information about UCS, refer to:
 https://www.univention.de/
```

--------------------------------

### Build and Install Translation Package

Source: https://docs.software-univention.de/developer-reference/latest/en/translation/umc

Builds the Debian translation package and installs it on the system. This involves setting up build dependencies, compiling the package, and then installing the resulting `.deb` file.

```shell
$ cd ~/translation/univention-l10n-fr
$ sudo apt-get build-dep .
$ dpkg-buildpackage -uc -us -b -rfakeroot
$ sudo dpkg -i ../univention-l10n-fr_*.deb

```

--------------------------------

### Create APT Repository Structure and Packages Index

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Provides shell commands to set up an APT repository structure on a web server and generate the necessary 'Packages' index file. This enables APT clients to discover and install packages.

```shell
WWW_BASE="/var/www/repository/5.2/maintained/component"
TESTCOMP="testcomp/all"
install -m755 -d "$WWW_BASE/$TESTCOMP"
install -m644 -t "$WWW_BASE/$TESTCOMP" *.deb
( cd "$WWW_BASE"
  rm -f "$TESTCOMP/Packages"*
  apt-ftparchive packages "$TESTCOMP" > "Packages"
  gzip -9 < "Packages" > "$TESTCOMP/Packages.gz"
  mv "Packages" "$TESTCOMP/Packages" )
```

--------------------------------

### Install univention-l10n Python Package

Source: https://docs.software-univention.de/developer-reference/latest/en/translation/package

Installs the univention-l10n Python package using pip from the cloned UCS repository. This step installs all required Python dependencies and makes the univention-l10n-build command available.

```shell
pip install ~/translation/univention-corporate-server/packaging/univention-l10n/
```

--------------------------------

### Enable Source Repository and Fetch Source

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Configures the system to access source code repositories and then fetches the source code for a specific package (e.g., univention-ssh) from the Univention Repository server.

```shell
sudo ucr set repository/online/sources=yes
apt-get update
apt-get source univention-ssh
cd univention-ssh-*/
```

--------------------------------

### Install Build Dependencies

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Installs all necessary build dependencies for the current Debian package source directory.

```console
$ sudo apt-get build-dep .
```

--------------------------------

### Create Package Directory

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Initializes the directory structure for a new UCS package and navigates into it. This is the first step in organizing your package files.

```bash
$ mkdir testdeb-0.1
$ cd testdeb-0.1
```

--------------------------------

### Debian control file dependency example

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/ucr/examples

An example snippet from a Debian `control` file, specifying build dependencies for a package. It includes `debhelper-compat` and `univention-config-dev`, noting that `univention-base-files` must be added manually as a runtime dependency due to its use in shell code.

```text
Source: service
Section: univention
Priority: optional
Maintainer: Univention GmbH <packages@univention.de>
Build-Depends:
 debhelper-compat (= 13),
 univention-config-dev (>= 15.0.3),
Standards-Version: 4.3.0.3

Package: service

```

--------------------------------

### Checkout Package from GIT

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/packaging

Clones the Univention Corporate Server repository from GitHub and navigates into the univention-ssh base package directory.

```console
$ git clone https://github.com/univention/univention-corporate-server.git
$ cd univention-corporate-server/base/univention-ssh
```

--------------------------------

### Debian postinst Script Example

Source: https://docs.software-univention.de/developer-reference/latest/en/listener/tasks-examples

This shell script is a post-installation script for a Debian package. It handles different package management actions like configuration, aborting upgrades, or removing packages. It specifically restarts the 'univention-directory-listener' service when configuring the package.

```shell
#!/bin/sh
set -e

case "$1" in
    configure)
        deb-systemd-invoke restart univention-directory-listener
        ;;
    abort-upgrade|abort-remove|abort-deconfigure)
        ;;
    *)
        echo "postinst called with unknown argument \`$1'" >&2
        exit 1
        ;;
    esac

#DEBHELPER#

exit 0
```

--------------------------------

### PO File Meta Information Example

Source: https://docs.software-univention.de/developer-reference/latest/en/translation/translation-files

An example excerpt from a `.po` translation file showing the meta information header. This section contains key-value pairs that define project details, translation status, and contact information.

```po
msgid ""
msgstr ""
"Project-Id-Version: univention-management-console-module-services\n"
"Report-Msgid-Bugs-To: packages@univention.de\n"
"POT-Creation-Date: 2020-09-25 01:15+0200\n"
"PO-Revision-Date: 2020-09-25 11:26+0100\n"
"Last-Translator: Univention GmbH <packages@univention.de>\n"
"Language-Team: Univention GmbH <packages@univention.de>\n"
"Language: de\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

```

--------------------------------

### Debian Install File Configuration

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Specifies which files to install and their destination paths within the package. This file is used by dh_install to place the Python script into /usr/bin/.

```debian-install
testdeb.py usr/bin/

```

--------------------------------

### Example: DelegateTelephonedNumber

Source: https://docs.software-univention.de/developer-reference/latest/en/udm/syntax

An example Python class derived from UDM_Attribute to retrieve user telephone numbers, displaying the user's display name along with their phone number.

```python
class DelegateTelephonedNumber(UDM_Attribute):
    udm_module = 'users/user'
    attribute = 'phone'
    label_format = '%(displayName)s: %($attribute$)s'
```

--------------------------------

### Add UCS APT Repository to sources.list

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

This example shows how to add a custom UCS APT repository to the `/etc/apt/sources.list` file on a UCS system. It specifies the repository URL and component, enabling `apt` to fetch packages from the configured location. The `[trusted=yes]` option is used for simplicity in this example.

```shell
deb [trusted=yes] http://repository.example.com/repository/5.2/maintained/component testcomp/all/
```

--------------------------------

### Initialize Debian Packaging Files

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Uses the dh_make command to create initial template files for a Debian package. This command requires maintainer information and package details.

```bash
$ dh_make --native --single --email user@example.com
```

--------------------------------

### Install Build Dependencies

Source: https://docs.software-univention.de/developer-reference/latest/en/packaging

Automatically installs all packages required to build the current Debian package based on its control file dependencies. This ensures the build environment is correctly set up.

```shell
sudo apt-get build-dep .
```

--------------------------------

### Debian Packaging Build Process

Source: https://docs.software-univention.de/developer-reference/latest/en/appendix/debian-packaging

Details the process of building Debian packages for Univention Corporate Server, including prerequisites and the use of `dh_make` for initial package structure generation.

```APIDOC
Prerequisites and preparation:
  - Ensure necessary build tools and libraries are installed (e.g., build-essential, devscripts).
  - Obtain the source code for the software to be packaged.

dh_make:
  - Command to create the initial debian/ directory structure for a new package.
  - Usage: dh_make -e <email> -f <orig-tarball>
  - Options: -s for single binary, -m for multiple binary, -n for native package.

Building:
  - Use dpkg-buildpackage to build the .deb package.
  - Command: dpkg-buildpackage -us -uc (to skip signing)
  - The resulting .deb file will be in the parent directory.
```

--------------------------------

### Install univention-l10n-dev on UCS

Source: https://docs.software-univention.de/developer-reference/latest/en/_sources/translation/package

Installs the univention-l10n-dev package on a UCS machine using the univention-install command. This makes the univention-l10n-build command available for translation tasks.

```console
$ univention-install univention-l10n-dev
```
Tokens:
Raw