Skip to content
  • Pack minimal shell script to debian package using fakeroot
  • Add postinst and other debian scripts to control the installation
  • Run the script as systemd service

install helper packages

1
sudo apt install fakeroot devscripts debhelper

Tutorial: Minimal

Check github simple_script tag source code

project

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
.
├── .vscode
│   ├── settings.json
│   └── tasks.json
├── debian
│   ├── changelog
│   ├── compat
│   ├── control
│   ├── my-tool.install
│   └── rules
├── debs
├── readme.md
├── .gitignore
└── scripts
    └── my-tool.sh
scripts/my-tool.sh
1
2
3
#!/bin/sh

echo "hello my-tool"

debian folder

Using fakeroot debian folder must contain this files:

  • compat
  • rules
  • changelog
  • control
  • my-tool.install

my-tools.install

Map a file from your project directory to its destination path in the installed system. For example, install the script into /usr/bin on the target filesystem.

debian/my-tools.install
1
scripts/my-tool.sh /usr/bin

Tip

The file name must match the Debian package name.

changelog

dch command create and update changelog file 

1
2
3
4
5
# create change log file
dch --create -v 0.0.1 --package my-tool "v 0.0.1"

# add entries
dch -v 0.0.1 "simple script"

control

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
Source: my-tools
Section: misc
Priority: optional
Maintainer: Your Name <youremail@example.com>
Standards-Version: 4.6.2

Package: my-tools
Architecture: all
Description: Minimal Debian package
 A short description of the minimal Debian package.

Note

The source section in mandatory by fakeroot

rules

1
2
3
4
5
6
7
#!/usr/bin/make -f

%:
    dh $@

override_dh_builddeb:
    dh_builddeb --destdir=$(CURDIR)/debs
change deb output path (debs folder must be exists)
1
2
override_dh_builddeb:
    dh_builddeb --destdir=$(CURDIR)/debs

Tip

The file must use TAB indentation

Check vscode settings to config rule file as shellscript with TAB indentation

compat

1
13

build

1
fakeroot debian/rules binary

clean

1
fakeroot debian/rules clean

VSCode

tasks.json

  • build using fakeroot debian/rules binary
  • clean fakeroot debian/rules clean
  • change log using dch
tasks.json 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
    // See https://code.visualstudio.com/docs/editor/tasks for more information
    "version": "2.0.0",
    "tasks": [
        {
            "label": "debian content",
            "type": "shell",
            "detail": "List the contents of the built debian package",
            "command": "dpkg -c ${input:myVersions}",
            "options": {
                "cwd": "${workspaceFolder}/debs"
            },
            "problemMatcher": []
        },
        {
            "label": "debian control",
            "type": "shell",
            "detail": "view debian control",
            "command": "dpkg -I ${input:myVersions}",
            "options": {
                "cwd": "${workspaceFolder}/debs"
            },
            "problemMatcher": []
        },
        {
            "label": "Build Debian Package",
            "type": "shell",
            "detail": "Build debian package",
            "command": "fakeroot debian/rules binary",
            "options": {
                "cwd": "${workspaceFolder}"
            },
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "problemMatcher": []
        },
        {
            "label": "Clean",
            "type": "shell",
            "detail": "Clean fakeroot output",
            "command": "fakeroot debian/rules clean",
            "options": {
                "cwd": "${workspaceFolder}"
            },
            "problemMatcher": []
        },
        {
            "label": "Update Changelog with dch",
            "type": "shell",
            "command": "dch --newversion ${input:changelogVersion} $(git log -1 --pretty=format:'* %s')",
            "options": {
                "cwd": "${workspaceFolder}",
                "env": {
                    "DEBEMAIL": "dev@example.com",
                    "DEBFULLNAME": "dev com"
                }
            },
            "problemMatcher": []
        }
    ],
    "inputs": [
        {
            "id": "changelogVersion",
            "type": "promptString",
            "description": "Enter the new version for dch"
        },
        {
            "id": "myVersions",
            "type": "pickString",
            "description": "Pick a version",
            "options": [
                "my-tools_0.0.1_all.deb",
                "my-tools_0.0.2_all.deb",
                "Option C"
            ]
        }
    ]
}

setting.json

Replace indentation from space to tab when using sheelscript

settings.json
1
2
3
    "files.associations": {
        "rules": "shellscript"
    }
settings.json 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "[shellscript]": {
        "editor.insertSpaces": false,
        "editor.tabSize": 4,
        "editor.detectIndentation": false
    },
    "files.associations": {
        "rules": "shellscript"
    }
}

using cat to check TAB indentation

1
cat -T <file>

Git

.gitignore

1
2
3
4
5
6
7
debs/
debian/*
!debian/changelog
!debian/rules
!debian/control
!debian/compat
!debian/my-tool.install

exclude file from ignore folder, for it to work we need to ignore files in folder and not the folder it self debian/*

dpkg

  • dpkg -c : List contents of a deb package.
  • dpkg -I : Show information about a package.

Debian scripts

Debian packages can include executable scripts that run automatically at different stages of installation, upgrade, and removal. These scripts live in the package’s debian/ directory.

Note

Don't forget to set executable permission

  • preinst
  • postinst
  • prerm
  • postrm

Scripts order

Install 1. preinst (install) 1. unpack files 1. postinst (configure)

Upgrade 1. preinst (upgrade) 1. unpack new files 1. postinst (configure)

Remove 1. prerm (remove) 1. remove files 1. postrm (remove)

Purge 1. postrm (purge)

Check for script existing

1
2
3
4
5
6
7
8
9
dpkg -I <package name>

#
 new Debian package, version 2.0.
 size 1100 bytes: control archive=472 bytes.
     237 bytes,     9 lines      control
     123 bytes,     2 lines      md5sums
      54 bytes,     7 lines   *  postinst             #!/bin/sh
      52 bytes,     7 lines   *  postrm               #!/bin/sh

Pack as systemd service

check source code github systemd_service tag

services/my-service.service
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
[Unit]
Description=mytool background service
After=network.target

[Service]
Type=simple
ExecStart=/usr/bin/my-tool.sh
Restart=on-failure
User=user
Group=user

[Install]
WantedBy=multi-user.target
debian/my-tools.install
1
2
scripts/my-tool.sh /usr/bin
services/my-service.service lib/systemd/system/
debian/postinst
1
2
3
4
5
6
7
8
#!/bin/sh
set -e

systemctl daemon-reload
systemctl enable my-service.service
systemctl start my-service.service

exit 0
debian/postrm
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
#!/bin/sh
set -e

if [ "$1" = "remove" ]; then
    systemctl stop my-service.service || true
fi

if [ "$1" = "purge" ]; then
    echo purge
fi

systemctl daemon-reload || true



exit 0

Install and check

journalctl
1
2
3
4
5
6
7
8
journalctl -u my-service.service 
#
Dec 01 08:42:07 omen systemd[1]: Started my-service.service - mytool background service.
Dec 01 08:42:07 omen my-tool.sh[650610]: hello my-tool
Dec 01 08:42:07 omen systemd[1]: my-service.service: Deactivated successfully.
Dec 01 10:07:11 omen systemd[1]: Started my-service.service - mytool background service.
Dec 01 10:07:11 omen my-tool.sh[705043]: hello my-tool
Dec 01 10:07:11 omen systemd[1]: my-service.service: Deactivated successfully.
systemctl status
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
sudo systemctl status my-service.service
# 
○ my-service.service - mytool background service
     Loaded: loaded (/usr/lib/systemd/system/my-service.service; enabled; preset: enabled)
     Active: inactive (dead) since Mon 2025-12-01 10:07:11 IST; 1min 15s ago
   Duration: 1ms
    Process: 705043 ExecStart=/usr/bin/my-tool.sh (code=exited, status=0/SUCCESS)
   Main PID: 705043 (code=exited, status=0/SUCCESS)
        CPU: 1ms

Dec 01 10:07:11 omen systemd[1]: Started my-service.service - mytool background service.
Dec 01 10:07:11 omen my-tool.sh[705043]: hello my-tool
Dec 01 10:07:11 omen systemd[1]: my-service.service: Deactivated successfully.

Tip

Check Remove using apt remove <package name>

for postrm script functionality

todo