init commit
This commit is contained in:
tavo-wasd
parent
0ee7e6632e
commit
8f7c589d03
2 changed files with 148 additions and 91 deletions
92
README.md
92
README.md
|
|
@ -1,92 +1,2 @@
|
|||
# Guides
|
||||
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
|
||||
## Add your files
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://gitlab.com/tavo-wasd/guides.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
|
||||
- [ ] [Set up project integrations](https://gitlab.com/tavo-wasd/guides/-/settings/integrations)
|
||||
|
||||
## Collaborate with your team
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
Compilation of guides for free and open source software.
|
||||
|
|
|
|||
147
wireless-network-debian/README.md
Normal file
147
wireless-network-debian/README.md
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
# How does it work?
|
||||
|
||||
By default, network interfaces will be automatically configured by
|
||||
the Debian installer in `/etc/network/interfaces`.
|
||||
There is a way to "call" a `wpa_supplicant.conf` configuration
|
||||
file in `/etc/network/interfaces` to handle
|
||||
_"accepted networks and security policies..."_ (WPA_SUPPLICANT.CONF(5)),
|
||||
using `wpasupplicant`.
|
||||
|
||||
Out of the box, Debian GNU/Linux 12 (as of writing) comes with the `wpasupplicant` package installed.
|
||||
So, you can connect to a wireless network without any extra software.
|
||||
This package gives access to the `wpa_passphrase` command to any user, and
|
||||
`wpa-action`, `wpa-cli` and `wpa_supplicant` commands to the root user,
|
||||
the _latter_ needs to be ran using a **root shell**, prepending `sudo` won't work.
|
||||
However, there is a way to configure new networks without `sudo`
|
||||
using `wpa_gui` as explained later.
|
||||
|
||||
# How to properly configure wireless networks
|
||||
|
||||
## Add `wpa-roam` command to `/etc/network/interfaces`
|
||||
|
||||
Firstly, remove any dhcp configured interfaces as they
|
||||
must be configured with manual mode for
|
||||
`wpa-roam` to work, the file `/etc/network/interfaces`:
|
||||
|
||||
```
|
||||
# This file describes the network interfaces available on your system
|
||||
# and how to activate them. For more information, see interfaces(5).
|
||||
|
||||
source /etc/network/interfaces.d/*
|
||||
|
||||
# The loopback network interface
|
||||
auto lo
|
||||
iface lo inet loopback
|
||||
|
||||
# The primary network interface
|
||||
allow-hotplug wlo1
|
||||
iface wlo1 inet dhcp
|
||||
wpa-ssid ExampleNetwork
|
||||
wpa-psk foob4r123
|
||||
```
|
||||
|
||||
Should be modified to look like this (comments can be ignored):
|
||||
|
||||
```
|
||||
# This file describes the network interfaces available on your system
|
||||
# and how to activate them. For more information, see interfaces(5).
|
||||
|
||||
source /etc/network/interfaces.d/*
|
||||
|
||||
# The loopback network interface
|
||||
auto lo
|
||||
iface lo inet loopback
|
||||
|
||||
# The primary network interface
|
||||
allow-hotplug wlo1
|
||||
iface wlo1 inet manual
|
||||
# *Removed previously configured network credentials,
|
||||
# *and set the interface to manual mode
|
||||
|
||||
# *This will allow wpa_supplicant
|
||||
wpa-roam /etc/wpa_supplicant/wpa_supplicant.conf
|
||||
iface default inet dhcp
|
||||
```
|
||||
|
||||
**Note**: Make sure this file is not readable by running:
|
||||
```shell
|
||||
sudo chown -R root:root /etc/network/interfaces
|
||||
sudo chmod 600 /etc/network/interfaces
|
||||
```
|
||||
|
||||
|
||||
## Configure `wpa_supplicant`
|
||||
|
||||
There are example files in `/usr/share/doc/wpa_supplicant/examples/`,
|
||||
`wpa_supplicant.conf` possibly being the most useful.
|
||||
However, this is the configuration that I personally use
|
||||
for `/etc/wpa_supplicant/wpa_supplicant.conf`:
|
||||
|
||||
```
|
||||
# This allows using wpa_cli
|
||||
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
|
||||
|
||||
# Allow wpa_supplicant to update configuration
|
||||
# For example when adding a new network
|
||||
update_config=1
|
||||
|
||||
# MAC Address randomization
|
||||
mac_addr=1
|
||||
preassoc_mac_addr=1
|
||||
gas_rand_mac_addr=1
|
||||
|
||||
network={
|
||||
ssid="ExampleNetwork"
|
||||
psk="foob4r123"
|
||||
}
|
||||
```
|
||||
|
||||
The `network{}` block shown above can be generated using
|
||||
`wpa_passphrase`, for example:
|
||||
|
||||
```shell
|
||||
wpa_passphrase "ExampleNetwork" "foob4r123"
|
||||
```
|
||||
|
||||
Will output:
|
||||
|
||||
```
|
||||
network={
|
||||
ssid="ExampleNetwork"
|
||||
#psk="foob4r123"
|
||||
psk=07765d3708cbabec40812cb1abaac936b420d6a0d951dd94dde372f96c86455f
|
||||
}
|
||||
```
|
||||
|
||||
Which then can be appended to the `/etc/wpa_supplicant/wpa_supplicant.conf` file.
|
||||
|
||||
**Note**: The `#psk=` line can be omitted for the hashed password.
|
||||
However, this will not prevent others with access to this hash
|
||||
to connect to the network, but at least it will not reveal the
|
||||
plain text password.
|
||||
|
||||
**Note**: Make sure this file is not readable by running:
|
||||
|
||||
```shell
|
||||
sudo chown -R root:root /etc/wpa_supplicant/wpa_supplicant.conf
|
||||
sudo chmod 600 /etc/wpa_supplicant/wpa_supplicant.conf
|
||||
```
|
||||
|
||||
## Tips
|
||||
|
||||
Now you can use `sudo wpa_cli` to configure networks
|
||||
using the command line, see WPA_CLI(8).
|
||||
|
||||
However, `wpagui` is a very small program
|
||||
that can ease the process of adding new networks.
|
||||
|
||||
**Note**: Go ahead and add your user to the netdev group
|
||||
with `usermod -a -G netdev youruser`
|
||||
|
||||
More interestingly it can re-configure
|
||||
`/etc/wpa_supplicant/wpa_supplicant.conf` with
|
||||
newly added networks without super user privileges.
|
||||
|
||||
**Note**: Sometimes it can make `/etc/wpa_supplicant/wpa_supplicant.conf`
|
||||
readable, to restore it: `sudo chmod 600 /etc/wpa_supplicant/wpa_supplicant.conf`
|
||||
will suffice.
|
||||
Loading…
Reference in a new issue