Skip to content

Commit 927f9eb

Browse files
author
ggtrd
committed
first try with docsify
1 parent fa89146 commit 927f9eb

File tree

5 files changed

+217
-0
lines changed

5 files changed

+217
-0
lines changed

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/CHANGELOG.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Bashpack changes
2+
3+
The released versions changelogs below are only about the main repository.
4+
5+
### 3.0.0
6+
*Incoming release date*
7+
##### Modified
8+
- The CLI has been redesigned has a "script manager", to download/install/run/remove scripts as subcommands
9+
- The CLI can now be installed offline by itself
10+
- Anyone can now host a repository for its own subcommands (edit sourceslist option from the configuration directory)
11+
- Anyone can now host a repository for its own CLI (edit cli_url option from the configuration file)
12+
- Repositories are compatibles with Github, but can also be simple directories listing web servers
13+
- The CLI helper can now easily create an automation from a simple function to be able to automatically run a subcommand on the system (systemd only for now)
14+
- When creating subcommands, the function "init_command()" can be used to run any requirements on the system (create automation, file etc... or anything else)
15+
- Subcommands provided from this project has moved to the [commands repository](https://github.com/bashpack-project/commands)
16+
- Subcommands "update" and "install" are now merged in the "package" subcommand
17+
- Subcommand "verify" option "-c/--commands" replaced by "-d/--dependencies"
18+
- Publication system has been removed and replaced by the configuration option "cli_url"
19+
20+
##### Fixed
21+
- Subcommand "firewall" restoration option wasn't able to read the given file name
22+
23+
------------
24+
### 2.0.0
25+
*2024/11/19*
26+
##### Added
27+
- Log support in /var/log/bashpack/ and "--get-logs" option
28+
- Subcommand "update" support of DNF (and YUM fallback)
29+
- Subcommand "firewall" for firewall management (nftables only for now)
30+
- This changelog file :D
31+
32+
##### Modified
33+
- Entirely rewritten to be compliant with POSIX systems
34+
- Self update improved to avoid downloading too much files
35+
- Self update can now be forced with "-u --force" option
36+
- Self installation improved by automatically detect the better $PATH
37+
- Self installation can now read a given publication with "-i publication_name"
38+
- Subcommand "verify" is now more used in installation process
39+
- Subcommand "verify" can now detect presence of required commands
40+
- Config file renamed from bashpack_config to bashpack.conf
41+
- Detection of systemd improved to be able to install on compatible systems only
42+
- Detection of pkg-config improved to be able to install on compatible systems only
43+
- Moving sources from /usr/local/src/ to /opt/
44+
45+
##### Removed
46+
- Subcommand "verify" download/extraction
47+
48+
------------
49+
### 1.1.1
50+
*2024/10/06*
51+
##### Added
52+
- Subcommand "verify" now replaces command option "-t"
53+
- Subcommand "verify" can now test repository reachability and test releases download/extraction
54+
55+
##### Modified
56+
- Self update is now taking in account the configuration file and the user custom values
57+
- Self update is now avoiding undesirables uninstallations
58+
59+
------------
60+
### 1.0.4
61+
*2024/07/23*
62+
##### Added
63+
- Configuration directory available at /etc/bashpack/
64+
- Publications stages with 3 repositories (main, unstable & dev)
65+
- New option to test installation "-t" (testing files presence only for now)
66+
67+
##### Modified
68+
- Detect if currently already in its latest version to avoid new installation at each update
69+
70+
------------
71+
### 0.3.0
72+
*2024/07/04*
73+
##### Added
74+
- Firmware upgrades for bare-metal systems (fwupd)

‎docs/README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Bashpack
2+
3+
Bashpack is a **user-friendly** Linux toolbox that has been designed to **quickly secure any Linux distro**.
4+
5+
It can be used for deployment purposes, or even by novices users (it doesn't require any specific knowledge).
6+
7+
<br>
8+
9+
## Features
10+
* Unified Linux updates \
11+
_one command to control them all_
12+
- [APT](https://wiki.debian.org/Apt)
13+
- [DNF](https://rpm-software-management.github.io/)
14+
- [YUM](http://yum.baseurl.org/)
15+
- [Snap](https://snapcraft.io/)
16+
- [fwupd](https://github.com/fwupd/fwupd) (firmwares)
17+
18+
* Secured Linux firewall \
19+
_block inbound and simplify rule creation_
20+
- [nftables](https://wiki.nftables.org/wiki-nftables/index.php/Main_Page)
21+
22+
<br>
23+
24+
25+
## Quick start
26+
Copy/paste the following command blocks on your Linux terminal to manage your Bashpack installation.
27+
28+
**Install**
29+
```shell
30+
curl -sL https://raw.githubusercontent.com/bashpack-project/bashpack/main/bashpack.sh -o bashpack.sh \
31+
&& chmod +x bashpack.sh \
32+
&& sudo ./bashpack.sh -i \
33+
&& rm bashpack.sh
34+
```
35+
36+
**Update**
37+
```shell
38+
sudo bp -u
39+
```
40+
41+
**Uninstall**
42+
```shell
43+
sudo bp --self-delete
44+
```
45+
46+
<br>
47+
48+
## Usage
49+
**Commands & options** are listed with the command:
50+
```shell
51+
bp --help
52+
```
53+
54+
<br>
55+
56+
### Command examples
57+
58+
#### Unified Linux updates
59+
Launch a pre-validated update of everything on your system
60+
```shell
61+
sudo bp update -y
62+
```
63+
64+
Check next update ([Systemd](https://systemd.io/) installations **only**)
65+
```shell
66+
sudo bp update --when
67+
```
68+
Get logs from last update ([Systemd](https://systemd.io/) installations **only**)
69+
```shell
70+
sudo bp update --get-logs
71+
```
72+
73+
<br>
74+
75+
76+
#### Secured Linux firewall
77+
**Install** a ruleset
78+
```shell
79+
sudo bp firewall -i
80+
```
81+
82+
**Restore** a backuped ruleset (made automatically during an installation)
83+
```shell
84+
sudo bp firewall --restore
85+
```
86+
87+
**Disable** the firewall
88+
```shell
89+
sudo bp firewall --disable
90+
```
91+
92+
<br>
93+
94+
## FAQ
95+
* Bashpack itself is POSIX, meaning it can be installed on any POSIX system (it was first written in [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)), but is now written in [Bourne shell](https://en.wikipedia.org/wiki/Bourne_shell)). That being said, every specific distro software support needs to be added one by one in the sub commands.
96+
* Root/sudo access is required.
97+
* [Systemd](https://systemd.io/) is highly recommanded to benefit all the automations.
98+
* Bashpack will automatically update itself ([Systemd](https://systemd.io/) installations only).
99+
* [fwupd](https://github.com/fwupd/fwupd) is installed only if your system is bare-metal (only [Systemd](https://systemd.io/) installations can detect it).
100+
* Multiple repositories exists. For production usage, only the [main](https://github.com/bashpack-project/bashpack) one should be used.
101+
* Just a funny command: bp man

‎docs/_sidebar.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!-- docs/_sidebar.md -->
2+
3+
* [Home](/)
4+
* [Changelog](CHANGELOG.md)

‎docs/index.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Document</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta name="description" content="Description">
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
9+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/dark.css">
10+
</head>
11+
<body>
12+
<div id="app"></div>
13+
<script>
14+
// 4. Docsify Configuration
15+
window.$docsify = {
16+
name: "Bashpack",
17+
homepage: "README.md",
18+
themeColor: '#c47c00',
19+
subMaxLevel: 4,
20+
21+
loadSidebar: true,
22+
23+
// 5. docsify-themeable
24+
themeable: {
25+
readyTransition : false,
26+
responsiveTables: false
27+
}
28+
};
29+
</script>
30+
<!-- Docsify v4 -->
31+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
32+
33+
<!-- Plugins -->
34+
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
35+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
36+
37+
</body>
38+
</html>

0 commit comments

Comments
 (0)