diff --git a/README.md b/README.md index 7f331a0..efe9dcf 100644 --- a/README.md +++ b/README.md @@ -1,140 +1,6 @@ -# Qubes-Community # -Here you can find the Community guide's, doc's, & wiki's. Furthermore you can also raise feedback discussions in the issue tracker. Keep in mind everything on Qubes Community is unofficial. If you haven't already, then it may be worthwhile to check the official Qubes doc's first, found [here](https://www.qubes-os.org/doc/). - - -### Caution before use ### -We, as in any Qubes-Community users, collaborators, members and owners, expect that anyone using anything produced, uploaded, adviced or otherwise, that comes out of the Qubes Community, to be met with a healthy amount of skepticism. Please be careful about running any scripts, following wiki's, doc's or guide's, which you don't understand what do. We take no responsibility for any damage or losses. We do however wish to keep the reliability, as well as security -and privacy, at the best quality possible, but we are not accountable for not meeting our goals. - -This site is run by volunteers. The Qubes OS Project is not affiliated with this site and does not endorse the content of any of these pages. - -### Infographics ### -Some icons replace other icons in a logical flow, for example finished can be used instead of sub-collection, if all sub-scripts are deemed finished. - -Finished | Updated, check date | Review(s) are needed | Development Paused - -Sub-collection | Work in progress | Looking for developers | Dangerous, don't use! - -_Credits and special thanks for icons goes to deleket @ deviantart._ - -### Review system ### -To be announced. - -
- -### Community doc's ### -All doc's here have the potential to one day become an official Qubes doc. Be mindful that they are still not perfect, and you must be careful when using them. -- [Official accepted Community doc's]() - - Right now this list-page is empty as we're only just starting out and has not forwarded any Community docs for official review. -- [Placeholder example of a Community released doc]() - - Work in progress, drafted Community doc's which are taking substantial time, will be listed here on current page. - - Finished and accepted Community doc's which has become Official Qubes doc's, are moved to the official accepted community doc's sub-collection folder. - - -
- - -### Commuinity wiki's ### -The centralized and all published decentralized github wiki's can be found here. -- [Qubes Community Wiki]() - Coming soon. -- Feel free to request for your Qubes wiki on helping Qubes related issues, to be linked here. - -
- -### Community external guide collection ### -- [Qubes 4 - Installing Win7](https://github.com/QubesOS/qubes-issues/issues/3585) - Official GitHub issue -- [Qubes Network Server](https://github.com/Rudd-O/qubes-network-server) - Third party GitHub repository. - - -
- - - -### Commuinity Script's ### -Here you can find the community scripts. Currently there is no review system in place for scripts. Be extra cautious before you run any of them. In time we plan to review and/or improve the quality of all the listed scripts. - -- [Qubes - A collection of small, but handy scripts](/scripts/qubes-a-small-but-handy-script-collection) - - Here you find our collection of smaller scripts, which are too small or too unqiue to be listed on this main page. There might be something useful in here though, so feel free to take a look once in a while as our collection grows and expands. -- [Qubes - Backup to AppVM script](/master/scripts/qvm-backup-to-appvm) - - A simple but potentially essential script to standardize your backup processes. - - May further be used, i.e. to put a timer on the script to perform automatically. -- [Qubes - Create minimal sys-vm](/scripts/qubes-create-minimal-sys-vms) - - This script is helpful to help set up a minimal template and turn it into a small appVM for sys-net and sys-firewall. - - The script can be modified to include other similar use-cases as well. - - Useful if setting up a new fresh Qubes system, or if you're unsure how to do minimal VM's. -- [Qubes - Easy dom0 to AppVM screenshotting](/scripts/qubes-screenshot-scripts) - - A collection of community screenshot scripts to handle the dom0 screenshot issue. -- [Qubes - Easy sound volume control](/scripts/qubes-sound-control-scripts) - - Here you can find our growing collection of sound control scripts. - - They're typical ideal to keybind. -- [Qubes - Move files to dom0](/scripts/qvm-copy-to-dom0) - - Moving files to dom0 is dangerous and discouraged, but if you must then here is a script to ease the process. - - If you know what you're doing, then this might be helpful. -- [Qubes 4 - Universal Update Script](/scripts/qubes-auto-update-script-alpha.sh) - - This script can update dom0 and all templates in a single click or keybind, starting from one end, automatically working itself through all your templaes and dom0 updates. - - The '-y' attribute option is not included, because it's seen as dangerous to auto-accept new updates without review, so it's expected for users to manually accept new updates. - - The script will continue automatically if no new updates are found. - - It can be modified to include extra templates, as well as changing between stable and current-testing. - - This script is also intended to ensure syncronization and avoid the fedora 48 hour cache issues, as well as to help keep repositories aligned across the whole Qubes system. -- [Qubes 4 - Win7 install - Guide/Script](/scripts/howto-build-win7-appvm) - - This script is designed to be a part guide, part script. Essentially it guides you through the commands to create a new Win7 VM. Please use the script as it was intended as a mixed guide/script. - - - -
- -### Community project's ### -These are extensive works which incorporate multiple of inter-connected scripts and coding, problems which also may require their own issue tracking lists, as well as a larger collaboration of community developers. Community project's hold a repository on their own. -- [Qubes-A.I. ](https://github.com/Qubes-Community/Qubes-A.I.) - - Offline & Open Source. Keeping your privacy and security as maximum priority. - - Initially Voice Control only, open A.I.'s are not quite as freely available yet as voice control is. - - Initially local only, but will eventually be possible to tunnel securely via encryption and private host. - - Project is fresh and require hands to speed it up. -- [Qubes-NAS](https://github.com/Qubes-Community/Qubes-NAS) - - Securing your NAS systems with a home-based server system. - - Initially the project will be local, but will eventually focus on becoming an internet based NAS server. - - Project is fresh and require hands to speed it up. -- [QubesTV](https://github.com/Qubes-Community/QubesTV) - - Securing your SmartTV from microphones, web-cams, voice-control, internet connections, with QubesTV. - - Almost no binaries are installed, this project relies heavily on easy to review scripts. The few binaries needed are reliable, for example pulseaudio-utils. - - Project development has started, extra hands are welcome. - -More projects to come as volunteers start them up. A project must go beyond the complexity of a script/guide, and involve complexity of inter-connected scripts, issue tracking, long-term development and updates, or other reasons that justifies it to become a project. - -
- -### Community guide's ### -Guides are not doc's which has the potential to reach the official Qubes doc's page. Instead guides are meant for more pure community oirentated how-to's. For example how to style your system to make it look better, or suggestions for how you can help contribute to the Qubes Community. - - - [Application recommendations for Qubes]() - - Generally apps which make sense on Qubes, as well as mostly free and open source. - - Coming soon. - - [Hardware Selection](/guides/hardware-tree.md) - - A decision tree that helps selecting proper hardware for Qubes OS. - - Be mindful that these are suggestive solutions, which helps narrowing down the options. Please research and double-check any outputs in the final selection. - - [Qubes Styling - XFCE4 w/ Launchers]() - - Suggestion and inspiration on how to make Qubes look better and more stylish. - - Guide how to be minimalistic and do it securely, and still make it look good. - - Picture illustrations are included. - - Coming soon. - -
- - -### Qubes server's - Guides & Scripts ### -Here you can find guides as well as scripts to a Qubes server of various types and sorts. -- [Qubes-A.I.-server ](https://github.com/Qubes-Community/Qubes-A.I.) - - Is a Qubes Community project. It is listed here as a dublicate due to its double project/server role. - - It may in the future serve as a private hosted A.I. system, for example in your home, acting as a server through encrypted channels to your various mobile devices. - - This is a very long-term project, which needs developers to succeed. -- [Qubes-NAS-server](https://github.com/Qubes-Community/Qubes-NAS) - - is a Qubes Community project. It is listed here as a dublicate due to its double project/server role. - - It may in the future serve as a private hosted NAS system, for example in your home, acting as a server through encrypted channelse to your various modbile devices. - - This is a future project, which might not be too far off, but also not too soon. It needs developers to speed it up. -- [Qubes-Wire-Chat-server](/scripts/qubes-wire-chat-server) - - Using the open source client Wire, with the open source server, set as a Qubes server. - - The potential here is possibly big for secure chat systems. Further experimentaton needs to be done, however it's looking good for now. - - This is the most near-term Qubes server setups to be finished among the known works. +This page is about the 'Contents' repository, which hosts user-contributed Documentation and code/resources. The project's main page is [here](https://qubes-community.github.io/) +User contributed Documentation and code/resources are respectively in the `docs/` and `code/` subfolders of the ['Contents'](https://github.com/Qubes-Community/Contents) repository. Please see the README.md in each of those folders for more information. +Ongoing submissions, reviews and QA are in [Issues](https://github.com/Qubes-Community/Contents/issues) and [pull requests](https://github.com/Qubes-Community/Contents/pulls) before new content is accepted in the repository (see [contributing](https://qubes-community.github.io/#contributing)). diff --git a/code/README.md b/code/README.md index 7a1a5d5..005b975 100644 --- a/code/README.md +++ b/code/README.md @@ -1,25 +1,20 @@ +### User-contributed code (scripts, programs, ...) + +**`dom0/`** - things meant to be run in dom0 + +- qvm-copy-to-dom0: copy files to dom0 (moving files to dom0 is dangerous and discouraged though) +- R4-universal-update-script.sh: unattented template update (whonix, ...) + +**`multimedia`** + +- sound-control-scripts: toggle, volume up, volume down, ... + +**`productivity`** + +- toggle-fullscreen-scripts +- screenshot-scripts -### Caution before use ### +**`server`** - using Qubes OS as a server -We, as in any Qubes-Community users, collaborators, members and owners, expect that anyone using anything produced, uploaded, adviced or otherwise, that comes out of the Qubes Community, to be met with a healthy amount of skepticism. Please be careful about running any scripts, following wiki's, doc's or guide's, which you don't understand what do. We take no responsibility for any damage or losses. We do however wish to keep the reliability, as well as security and privacy, at the best quality possible, but we are not accountable for not meeting our goals. - -This site is run by volunteers. The Qubes OS Project is not affiliated with this site and does not endorse the content of any of these pages. - -# Description of scripts -## howto-build-win7-appvm -a howto which will list all steps to create Windows 7 HVM in Qubes 4. -Starting from booting up the ISO, installing Qubes Windows Tools, Fixing networking and enabling seamless mode. - -## qubes-auto-update-script-alpha.sh -? to be defined ? - -## qubes-create-minimal-sys-vms -describes how to provision sys-net / sys-usb / sys-firewall based on fedora-26-minimal templates instead of a full fedora-template. - -## qvm-backup-to-appvm -script which can copy data from dom0 to an gzipped tarfile in an AppVM. - -## qvm-copy-to-dom0 -script which can copy data from an AppVM to a location in dom0. -(script must be launched from dom 0) +- see README.md diff --git a/code/multimedia/sound-control-scripts/README.md b/code/multimedia/sound-control-scripts/README.md deleted file mode 100644 index 343838c..0000000 --- a/code/multimedia/sound-control-scripts/README.md +++ /dev/null @@ -1,10 +0,0 @@ -### Qubes sound control scripts -Here you may find various of different kinds of Qubes sound control. Some work in other *nix operation systems as well, but others are Qubes specific, for example volume control of specific AppVM's. (More will be uploded later). - - -### Caution before use ### - -We, as in any Qubes-Community users, collaborators, members and owners, expect that anyone using anything produced, uploaded, adviced or otherwise, that comes out of the Qubes Community, to be met with a healthy amount of skepticism. Please be careful about running any scripts, following wiki's, doc's or guide's, which you don't understand what do. We take no responsibility for any damage or losses. We do however wish to keep the reliability, as well as security and privacy, at the best quality possible, but we are not accountable for not meeting our goals. - -This site is run by volunteers. The Qubes OS Project is not affiliated with this site and does not endorse the content of any of these pages. - diff --git a/code/productivity/screenshot-scripts/README.md b/code/productivity/screenshot-scripts/README.md deleted file mode 100644 index 180a2ce..0000000 --- a/code/productivity/screenshot-scripts/README.md +++ /dev/null @@ -1,9 +0,0 @@ -### Screenshot scripts ### -Here you have different choices, inspect and find one that matches your needs. - - -### Caution before use ### - -We, as in any Qubes-Community users, collaborators, members and owners, expect that anyone using anything produced, uploaded, adviced or otherwise, that comes out of the Qubes Community, to be met with a healthy amount of skepticism. Please be careful about running any scripts, following wiki's, doc's or guide's, which you don't understand what do. We take no responsibility for any damage or losses. We do however wish to keep the reliability, as well as security and privacy, at the best quality possible, but we are not accountable for not meeting our goals. - -This site is run by volunteers. The Qubes OS Project is not affiliated with this site and does not endorse the content of any of these pages. diff --git a/code/productivity/toggle-fullscreen-scripts/README.md b/code/productivity/toggle-fullscreen-scripts/README.md deleted file mode 100644 index bd88904..0000000 --- a/code/productivity/toggle-fullscreen-scripts/README.md +++ /dev/null @@ -1,9 +0,0 @@ -### A small, but handy script collection ### -Here you may find all small community scripts which does not fall logically into a script theme folder, or scripts which are too rarely used to be listed on the script overview list. - -### Caution before use ### - -We, as in any Qubes-Community users, collaborators, members and owners, expect that anyone using anything produced, uploaded, adviced or otherwise, that comes out of the Qubes Community, to be met with a healthy amount of skepticism. Please be careful about running any scripts, following wiki's, doc's or guide's, which you don't understand what do. We take no responsibility for any damage or losses. We do however wish to keep the reliability, as well as security and privacy, at the best quality possible, but we are not accountable for not meeting our goals. - -This site is run by volunteers. The Qubes OS Project is not affiliated with this site and does not endorse the content of any of these pages. - diff --git a/code/server/README.md b/code/server/README.md new file mode 100644 index 0000000..5682af4 --- /dev/null +++ b/code/server/README.md @@ -0,0 +1,12 @@ +### Using Qubes OS as a server + +Hosted repositories: + +- [Qubes-A.I.-server ](https://github.com/Qubes-Community/Qubes-A.I.): serve as a private hosted A.I. system, for example in your home, acting as a server through encrypted channels to your various mobile devices (WIP). +- [Qubes-NAS-server](https://github.com/Qubes-Community/Qubes-NAS): serve as a private hosted NAS system, for example in your home, acting as a server through encrypted channels to your various modbile devices (WIP). + + +External links: + +- [Qubes Network Server](https://github.com/Rudd-O/qubes-network-server) + diff --git a/code/staging/README.md b/code/staging/README.md new file mode 100644 index 0000000..0be9bfd --- /dev/null +++ b/code/staging/README.md @@ -0,0 +1,4 @@ +- create-minimal-sys-vms : should be a doc +- howto-build-win7-appvm : ditto +- qvm-backup-to-appvm : isn't backup related ; +, why not use qvm-run vmname 'mv ...' instead of helper script. + diff --git a/code/vm-creation/create-minimal-sys-vms b/code/staging/create-minimal-sys-vms similarity index 100% rename from code/vm-creation/create-minimal-sys-vms rename to code/staging/create-minimal-sys-vms diff --git a/code/vm-creation/howto-build-win7-appvm b/code/staging/howto-build-win7-appvm similarity index 100% rename from code/vm-creation/howto-build-win7-appvm rename to code/staging/howto-build-win7-appvm diff --git a/code/backups/qvm-backup-to-appvm b/code/staging/qvm-backup-to-appvm similarity index 100% rename from code/backups/qvm-backup-to-appvm rename to code/staging/qvm-backup-to-appvm diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..d6be88b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +### User-contributed documentation + +- [Tips on choosing the right hardware](hardware-selection.md) diff --git a/github-resources/README.md b/icons/README.md similarity index 100% rename from github-resources/README.md rename to icons/README.md diff --git a/github-resources/review-icons/Button Check-01.png b/icons/review-icons/Button Check-01.png similarity index 100% rename from github-resources/review-icons/Button Check-01.png rename to icons/review-icons/Button Check-01.png diff --git a/github-resources/review-icons/Button Close-01.png b/icons/review-icons/Button Close-01.png similarity index 100% rename from github-resources/review-icons/Button Close-01.png rename to icons/review-icons/Button Close-01.png diff --git a/github-resources/review-icons/Button Help-01.png b/icons/review-icons/Button Help-01.png similarity index 100% rename from github-resources/review-icons/Button Help-01.png rename to icons/review-icons/Button Help-01.png diff --git a/github-resources/review-icons/Button Info-01.png b/icons/review-icons/Button Info-01.png similarity index 100% rename from github-resources/review-icons/Button Info-01.png rename to icons/review-icons/Button Info-01.png diff --git a/github-resources/review-icons/Button Pause-01.png b/icons/review-icons/Button Pause-01.png similarity index 100% rename from github-resources/review-icons/Button Pause-01.png rename to icons/review-icons/Button Pause-01.png diff --git a/github-resources/review-icons/Button Refresh-01.png b/icons/review-icons/Button Refresh-01.png similarity index 100% rename from github-resources/review-icons/Button Refresh-01.png rename to icons/review-icons/Button Refresh-01.png diff --git a/github-resources/review-icons/Gear-01.png b/icons/review-icons/Gear-01.png similarity index 100% rename from github-resources/review-icons/Gear-01.png rename to icons/review-icons/Gear-01.png diff --git a/github-resources/review-icons/Plastic Mini by deleket on DeviantArt.desktop b/icons/review-icons/Plastic Mini by deleket on DeviantArt.desktop similarity index 100% rename from github-resources/review-icons/Plastic Mini by deleket on DeviantArt.desktop rename to icons/review-icons/Plastic Mini by deleket on DeviantArt.desktop diff --git a/github-resources/review-icons/User New-01.png b/icons/review-icons/User New-01.png similarity index 100% rename from github-resources/review-icons/User New-01.png rename to icons/review-icons/User New-01.png