Atlas - README.txt
Home / doc / DPX / DPX25-234545
Lines: 1 | Size: 3301 bytes
[Download] [Show on GitHub] [Search similar files] [Raw] [Raw (proxy)] 
[FILE BEGIN]
1Title: UNIX Configuration Archiving Structure
2Publisher: 0x4248
3Design Proposal Exchange: 25-234545
4Category: Design and Protocol
5Version: 1.0
6Copyrights: © 2026 0x4248. CC0. All rights are given
7Usage rights: All rights given
8License: CC0
9                                                                          0x4248
10                                                                  8 January 2026
11                                                        Design Proposal Exchange
12                UNIX Configuration Archiving Structure
13                            DPX25-234545
14
15A design for sharing and archiving UNIX based system configuration such as 
16dotfiles, application settings, and system preferences in a standardized
17structure.
18
19BRIEF
20
21When archiving and sharing UNIX configuration files that is system wide it can 
22be confusing to know what requirements are needed or where a folder may belong.
23
24This design proposal aims to create a standardized structure for archiving and
25sharing UNIX configuration files to make it easier for users to backup, restore,
26and share their system settings.
27
28This DPX also applies to Linux and other UNIX-like operating systems.
29
30SPECIFICATION
31
32There are three main components to a repository that follows this design:
331. Filesystem and System Files
342. User Configuration Files
353. Documentation, Metadata, and Install Scripts
36
37
381. Filesystem and System Files
39
40In the repository root, there should be a folder named either:
41- fs (preferred)
42- rootfs
43- root
44
45This folder is basically the root (/) of the UNIX system. It does not however
46need to contain all the system files (and doing so is significantly discouraged).
47Only include configuration files that are relevant to the system setup and
48configuration. For example if i want to share my NTP configuration, I would
49include /etc/ntp.conf in this folder structure. This file would be located at
50<repository-root>/fs/etc/ntp.conf.
51
522. User Configuration Files
53
54User specific configuration files such as dotfiles and application settings
55should be placed in a folder named either:
56- home (preferred)
57- user
58
59Now why? Why not put it in /home/username? The reason is simple, this way it
60is user agnostic and can be used by any user.
61
62Now Jane, Mike and Alice can all use the same repository to setup their user
63configuration without needing to change anything or even type in their username,
64since ~ is a standard symlink to the home directory of the current user.
65
663. Documentation, Metadata, and Install Scripts
67
68In the repository root, there should be these main files:
69- README.txt OR README.md : A documentation file that explains the configuration
70  files included, any special instructions, and any other relevant information.
71- INSTALL.sh OR INSTALL.md : An optional installation script or instructions
72  for applying the configuration files to a system.
73- LICENSE : A file that outlines the usage rights and license for the repository.
74- REQUIREMENTS.txt : An optional file that lists any dependencies or prerequisites
75  needed for the configuration files to work properly.
76- METADATA.json OR METADATA.txt : An optional metadata file that includes
77  information about the repository such as author, version, date created,
78  and any other relevant details. However this is optional and not required.
79
80
[FILE END]
(C) 2025 0x4248
(C) 2025 4248 Media and 4248 Systems, All part of 0x4248
See LICENCE files for more information. Not all files are by 0x4248 always check Licencing.