1toolbox-init-container(1)   General Commands Manual  toolbox-init-container(1)
2
3
4

NAME

6       toolbox-init-container - Initialize a running container
7
8

SYNOPSIS

10       toolbox init-container --gid GID
11                              --home HOME
12                              --home-link
13                              --media-link
14                              --mnt-link
15                              --shell SHELL
16                              --uid UID
17                              --user USER
18
19

DESCRIPTION

21       Initializes  a  newly created container that's running. It is primarily
22       meant to be used as the entry point for  all  toolbox  containers,  and
23       must  be  run  inside the container that's to be initialized. It is not
24       expected to be directly invoked by humans, and cannot be  used  on  the
25       host.
26
27
28       A  key  feature of toolbox containers is their entry point, the toolbox
29       init-container command.
30
31
32       OCI containers are inherently immutable. Configuration  options  passed
33       through  podman  create  are  baked into the definition of the OCI con‐
34       tainer, and can't be changed later. This means  that  changes  and  im‐
35       provements  made  in newer versions of Toolbox can't be applied to pre-
36       existing toolbox containers created by older versions of Toolbox.  This
37       is  avoided by using the entry point to configure the container at run‐
38       time.
39
40
41       The entry point of a toolbox container customizes the container to  fit
42       the current user by ensuring that it has a user that matches the one on
43       the host, and grants it sudo and root access.
44
45
46       Crucial  configuration  files,  such  as  /etc/host.conf,   /etc/hosts,
47       /etc/localtime,  /etc/resolv.conf  and  /etc/timezone,  inside the con‐
48       tainer are kept synchronized with the host. The entry point  also  bind
49       mounts various subsets of the host's filesystem hierarchy to their cor‐
50       responding locations inside the container to provide seamless  integra‐
51       tion  with  the host. This includes /run/libvirt, /run/systemd/journal,
52       /run/udev/data,      /var/lib/libvirt,       /var/lib/systemd/coredump,
53       /var/log/journal and others.
54
55
56       On  some  host operating systems, important paths like /home, /media or
57       /mnt are symbolic links to other locations.  The  entry  point  ensures
58       that paths inside the container match those on the host, to avoid need‐
59       less confusion.
60
61

OPTIONS

63       The following options are understood:
64
65
66       --gid GID
67
68
69       Pass GID as the user's numerical group ID from the host to the  toolbox
70       container.
71
72
73       --home HOME
74
75
76       Create  a  user  inside  the toolbox container whose login directory is
77       HOME. This option is required.
78
79
80       --home-link
81
82
83       Make /home a symbolic link to /var/home.
84
85
86       --media-link
87
88
89       Make /media a symbolic link to /run/media.
90
91
92       --mnt-link
93
94
95       Make /mnt a symbolic link to /var/mnt.
96
97
98       --monitor-host
99
100
101       Deprecated, does nothing.
102
103
104       Crucial configuration files inside the  toolbox  container  are  always
105       kept synchronized with their counterparts on the host, and various sub‐
106       sets of the host's file system hierarchy are  always  bind  mounted  to
107       their corresponding locations inside the toolbox container.
108
109
110       --shell SHELL
111
112
113       Create  a user inside the toolbox container whose login shell is SHELL.
114       This option is required.
115
116
117       --uid UID
118
119
120       Create a user inside the toolbox container whose numerical user  ID  is
121       UID. This option is required.
122
123
124       --user USER
125
126
127       Create  a  user inside the toolbox container whose login name is LOGIN.
128       This option is required.
129
130

SEE ALSO

132       toolbox(1), podman(1), podman-create(1), podman-start(1)
133
134
135
136                                                     toolbox-init-container(1)
Impressum