You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/CONTRIBUTING.md
+15-12Lines changed: 15 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,12 @@ permalink: /contributing
8
8
9
9
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
10
10
11
-
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
12
-
> - Star the project [in GitHub](https://github.com/secureblue/secureblue)
13
-
> - Tweet about it
14
-
> - Refer this project in your project's readme
15
-
> - Mention the project at local meetups and tell your friends/colleagues
11
+
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
12
+
13
+
- Star the project [in GitHub](https://github.com/secureblue/secureblue)
14
+
- Tweet about it
15
+
- Refer this project in your project's readme
16
+
- Mention the project at local meetups and tell your friends/colleagues
> If you want to ask a question, opening a [GitHub issue](https://github.com/secureblue/secureblue) for it is preferred, but [Discord](https://discord.gg/qMTv5cKfbF) is available as well.
38
+
If you want to ask a question, opening a [GitHub issue](https://github.com/secureblue/secureblue) for it is preferred, but [Discord](https://discord.gg/qMTv5cKfbF) is available as well.
38
39
39
40
## I Want To Contribute
40
41
41
-
> ### Legal Notice
42
-
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
42
+
### Legal Notice
43
+
44
+
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
43
45
44
-
> ### AI Content Policy
45
-
> In the interest of accuracy, quality, and license of the project, contributing using AI generated code and content of any kind is forbidden.
46
+
### AI Content Policy
47
+
48
+
In the interest of accuracy, quality, and license of the project, contributing using AI generated code and content of any kind is forbidden.
46
49
47
50
### Reporting Bugs
48
51
@@ -143,7 +146,7 @@ Copy `/etc/containers/policy.json` to `~/.config/containers/policy.json` and the
143
146
144
147
### Making changes
145
148
146
-
Configuration is stored in `recipes` folder in form of YAML files. Other files to be added to the image are stored in `files`. `common` holds pluggable modules to add to your custom image. `general` and `securecore` hold configs for the desktop and server images, respectively. Documentation for modules can be found [here](https://blue-build.org/learn/getting-started/).
149
+
Configuration is stored in `recipes` folder in form of YAML files. Other files to be added to the image are stored in `files`. `common` holds pluggable modules to add to your custom image. `general` and `securecore` hold configs for the desktop and server images, respectively. Modules are detailed in [BlueBuild's documentation](https://blue-build.org/learn/getting-started/).
Copy file name to clipboardExpand all lines: content/DONATE.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ description: "Donation options for secureblue"
4
4
permalink: /donate
5
5
---
6
6
7
+
# Donate
8
+
7
9
All donations are appreciated. Sponsors get a role on the [Discord](https://discord.gg/qMTv5cKfbF) if desired. If you've donated but haven't yet been tagged with the role, please reach out to RoyalOughtness.
8
10
9
11
There are multiple options available for donation:
@@ -14,24 +16,24 @@ There are multiple options available for donation:
14
16
15
17
## Bitcoin
16
18
17
-
<imgsrc="/assets/bitcoin.png"width=200 />
19
+
<imgalt="Bitcoin donation QR code"src="/assets/bitcoin.png"width=200 />
18
20
19
21
`bc1qj4nxpfhsgj3f7w8c2689kq865apfla2jyxgaem`
20
22
21
23
## Monero
22
24
23
-
<imgsrc="/assets/monero.png"width=200 />
25
+
<imgalt="Monero donation QR code"src="/assets/monero.png"width=200 />
During rpm-ostree operations, it's normal. Outside of that, make sure you followed the NVIDIA steps in the [post-install instructions](/post-install#nvidia) if you're using an NVIDIA GPU.
51
50
52
-
####Should I use firejail?
51
+
### Should I use firejail?
53
52
{: #firejail}
54
53
55
54
[No](https://madaidans-insecurities.github.io/linux.html#firejail), use ``bubblejail`` if there's no flatpak available for an app.
56
55
57
-
####An app I use won't start due to a malloc issue. How do I fix it?
56
+
### An app I use won't start due to a malloc issue. How do I fix it?
58
57
{: #standard-malloc}
59
58
60
59
- For flatpaks, remove the `LD_PRELOAD` environment variable via Flatseal. To re-enable hardened_malloc for the respective flatpak, replace the removed variable.
61
60
- For layered packages and packages installed via brew, run the application with `ujust with-standard-malloc APP`. This starts the app without hardened_malloc only once, it does not disable hardened_malloc for the app persistently.
62
61
63
-
####On secureblue half of my CPU cores are gone. Why is this?
62
+
### On secureblue half of my CPU cores are gone. Why is this?
64
63
{: #smt}
65
64
66
65
`mitigations=auto,nosmt` is set on secureblue. This means that if your CPU is vulnerable to attacks that utilize [Simultaneous Multithreading](https://en.wikipedia.org/wiki/Simultaneous_multithreading), SMT will be disabled.
67
66
68
-
####How do I install software?
67
+
### How do I install software?
69
68
{: #software}
70
69
71
70
1. Check if it's already installed using `rpm -qa | grep x`
@@ -75,19 +74,19 @@ During rpm-ostree operations, it's normal. Outside of that, make sure you follow
75
74
76
75
Steam is an exception to the above.
77
76
78
-
####How do I install Steam?
77
+
### How do I install Steam?
79
78
{: #steam}
80
79
81
80
```
82
81
ujust install-steam
83
82
```
84
83
85
-
####Another security project has a feature that's missing in secureblue, can you add it?
84
+
### Another security project has a feature that's missing in secureblue, can you add it?
86
85
{: #feature-request}
87
86
88
-
First check [this](/#hardening) on whether it already lists an equivalent or better feature. If it doesn't, open a new [GitHub issue](https://github.com/secureblue/secureblue/issues).
87
+
First check our [features list](/features) on whether it already lists an equivalent or better feature. If it doesn't, open a new [GitHub issue](https://github.com/secureblue/secureblue/issues).
89
88
90
-
####Why are bluetooth kernel modules disabled? How do I enable them?
89
+
### Why are bluetooth kernel modules disabled? How do I enable them?
91
90
{: #bluetooth}
92
91
93
92
Bluetooth has a long and consistent history of security issues. However, if you still need it, run:
@@ -96,12 +95,12 @@ Bluetooth has a long and consistent history of security issues. However, if you
96
95
ujust toggle-bluetooth-modules
97
96
```
98
97
99
-
####Why are upgrades so large?
98
+
### Why are upgrades so large?
100
99
{: #upgrade-size}
101
100
102
101
This is an issue with rpm-ostree image-based systems generally, and not specific to secureblue. Ideally upgrades would come in the form of a zstd-compressed container diff, but it's not there yet. Check out [this upstream issue](https://github.com/coreos/rpm-ostree/issues/4012) for more information.
103
102
104
-
####Why can't I install new KDE themes?
103
+
### Why can't I install new KDE themes?
105
104
{: #ghns}
106
105
107
106
The functionality that provides this, called GHNS, is disabled by default due to the risk posed by the installation of potentially damaging or malicious scripts. This has caused [real damage](https://blog.davidedmundson.co.uk/blog/kde-store-content/).
@@ -112,7 +111,7 @@ If you still want to enable this functionality, run:
112
111
ujust toggle-ghns
113
112
```
114
113
115
-
####Why doesn't my Xwayland app work?
114
+
### Why doesn't my Xwayland app work?
116
115
{: #xwayland}
117
116
118
117
Xwayland is disabled by default on GNOME, KDE Plasma, and Sway. If you need it, run:
@@ -121,7 +120,7 @@ Xwayland is disabled by default on GNOME, KDE Plasma, and Sway. If you need it,
121
120
ujust toggle-xwayland
122
121
```
123
122
124
-
####Why I can't install nor use any GNOME user extensions?
123
+
### Why I can't install nor use any GNOME user extensions?
125
124
{: #gnome-extensions}
126
125
127
126
This is because support for installing & using them has been intentionally disabled by default in secureblue.
@@ -133,26 +132,21 @@ To enable support for installing GNOME user extensions, you can run ujust comman
133
132
ujust toggle-gnome-extensions
134
133
```
135
134
136
-
####My clock is wrong and it's not getting automatically set. How do I fix this?
135
+
### My clock is wrong and it's not getting automatically set. How do I fix this?
137
136
{: #clock}
138
137
139
138
If your system time is off by an excessive amount due to rare conditions like a CMOS reset, your network will not connect. A one-time manual reset will fix this. This should never be required except under very rare circumstances.
140
139
141
140
For more technical detail, see [#268](https://github.com/secureblue/secureblue/issues/268)
142
141
143
-
#### Why is DNS broken on my secureblue VM?
144
-
{: #vm-dns}
145
-
146
-
The DNSSEC setting we set in `/etc/systemd/resolved.conf.d/securedns.conf` causes known issues with network connectivity when secureblue is used in a VM. To fix it, comment out `DNSSEC=allow-downgrade` in that file and manually set a dns provider in network settings.
147
-
148
-
#### How do I get notified of new releases?
142
+
### How do I get notified of new releases?
149
143
{: #releases}
150
144
151
145
To subscribe to release notifications, on the secureblue GitHub page, click "Watch", and then "Custom", and select Releases like so:
AppImages depend on fuse2, which is unmaintained and depends on a suid root binary. For this reason, fuse2 support is removed by default. It's strongly recommended that you find alternative mechanisms to install your applications (flatpak, distrobox, etc). If you can't find an alternative and still need fuse2, you can add it back by layering something that depends on it.
@@ -163,19 +157,19 @@ For example:
163
157
rpm-ostree install zfs-fuse
164
158
```
165
159
166
-
####Why don't KDE Vaults work?
160
+
### Why don't KDE Vaults work?
167
161
{: #kde-vaults}
168
162
169
163
Similar to the AppImage FAQ, the KDE Vault default backend `cryfs` depends on fuse2. For this reason it's recommended that you migrate to an alternative that doesn't depend on fuse2, for example `fscrypt`. If you don't want to do so, you can add fuse2 back by layering something that depends on it, as described in the AppImage FAQ.
170
164
171
-
####How do I provision signed distroboxes?
165
+
### How do I provision signed distroboxes?
172
166
{: #distrobox-assemble}
173
167
174
168
```
175
169
ujust distrobox-assemble
176
170
```
177
171
178
-
####Why aren't my apps loading on Nvidia Optimus?
172
+
### Why aren't my apps loading on Nvidia Optimus?
179
173
{: #nvidia-optimus}
180
174
181
175
There is an [upstream bug](https://discussion.fedoraproject.org/t/gdk-message-error-71-protocol-error-dispatching-to-wayland-display/127927/21). You may need to run:
This should no longer be required as of F41: https://discussion.fedoraproject.org/t/gdk-message-error-71-protocol-error-dispatching-to-wayland-display/127927/42
188
182
189
-
####Why won't `hardened-chromium` start?
183
+
### Why won't `hardened-chromium` start?
190
184
{: #hardened-chromium-start}
191
185
192
186
Try starting `hardened-chromium` from the commandline by running `chromium-browser`. If you get an error about the current profile already running on another device, this is an issue with upstream chromium which can happen when you `rpm-ostree update` or `rpm-ostree rebase`. To fix this, simply run `rm ~/.config/chromium/SingletonLock`.
193
187
194
188
`bubblejail`**SHOULD NOT** be used on `hardened-chromium`, there are issues reported with the pairing and removing the `bubblejail` config after it is applied can be difficult. It should also be noted that applying additional sandboxing may interfere with chromium's own internal sandbox, so it can end up reducing security.
195
189
196
-
####Why won't `hardened-chromium` start on Nvidia?
190
+
### Why won't `hardened-chromium` start on Nvidia?
197
191
{: #hardened-chromium-start-nvidia}
198
192
199
193
On some Nvidia machines, `hardened-chromium` defaults to the X11 backend. Since secureblue disables Xwayland by default, this means that you will need to run `ujust toggle-xwayland` and reboot, for `hardened-chromium` to work.
200
194
201
-
####Why don't some websites that require JIT/WebAssembly work in `hardened-chromium` even with the V8 Optimizer toggle enabled?
195
+
### Why don't some websites that require JIT/WebAssembly work in `hardened-chromium` even with the V8 Optimizer toggle enabled?
202
196
{: #hardened-chromium-exceptions}
203
197
204
198
This is an [upstream bug](https://issues.chromium.org/issues/373893056) that prevents V8 optimization settings from being applied to iframes embedded within a parent website. As a result, WebAssembly may not function on services that use a separate URL for their content delivery network or other included domains, such as VSCode Web ([https://github.dev](https://github.dev)). To make VSCode Web work properly, you need to manually allow V8 optimizations for the CDN by adding `https://[*.]vscode-cdn.net` to your list of trusted websites.
205
199
206
-
####Why don't extensions work in `hardened-chromium`?
200
+
### Why don't extensions work in `hardened-chromium`?
207
201
{: #hardened-chromium-extensions}
208
202
209
203
Extensions in `hardened-chromium` are disabled by default, for security reasons it is not advised to use them. If you want content/ad blocking, that is already built into `hardened-chromium` and enabled by default. If you require extensions, you can re-enable them by disabling the `Disable Extensions` toggle under `chrome://settings/security`, then restart your browser (this toggle is per-profile).
210
204
\
211
205
\
212
206
If the extension you installed doesn't work, it is likely because it requires WebAssembly (WASM) for some cryptographic library or some other optimizations (this is the case with the Bitwarden extension). To re-enable JavaScript JIT and WASM for extensions, enable the feature `chrome://flags/#internal-page-jit`.
213
207
214
-
####How do I customize secureblue?
208
+
### How do I customize secureblue?
215
209
{: #customization}
216
210
217
-
If you want to add your own customizations on top of secureblue, you are advised strongly against forking. Instead, create a repo for your own image by using the [BlueBuild template](https://github.com/blue-build/template), then change your `base-image` to a secureblue image. This will allow you to apply your customizations to secureblue in a concise and maintainable way, without the need to constantly sync with upstream. For local development, [building locally](/contributing#building-locally) is the recommended approach.
211
+
If you want to add your own customizations on top of secureblue, you are advised strongly against forking. Instead, create a repo for your own image by using the [BlueBuild template](https://github.com/blue-build/template), then change your `base-image` to a secureblue image. This will allow you to apply your customizations to secureblue in a concise and maintainable way, without the need to constantly sync with upstream. For local development, [building locally](/contributing#building-locally) is the recommended approach.
0 commit comments