Skip to content
Snippets Groups Projects
Commit 875ef459 authored by Rafael László's avatar Rafael László :speech_balloon:
Browse files

Add docs

parent 382eb5e7
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
README.md
+ 48
− 80
View file @ 875ef459
# maze-v2 # maze-v2
This repository contains configurations used for my server.
# Infra
## 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 ┌────────┐ ┌──VM──────┐
git remote add origin https://git.sch.bme.hu/rlacko/maze-v2.git │Internet├─┬────┤ SCH VPN │
git branch -M main └─────┬──┘ │ └──────┬───┘
git push -uf origin main │ │ │
│ │ │
│ │ │
│ │ ┌────┴─────────┐
┌──┴────┴─┐ │ Admin Switch │
│ Switch │ │ │
└────┬────┘ └────┬─────────┘
│Trunk │
│211,152 │
┌─┴──┐ ┌────┴──┐
│ U1 │ │ Admin │
┌───┴────┴──────┴───────┴─┐
│Maze │
│ │
│ │
│ ESXi virtualization │
│ │
│ - VyOS VM │
│ │
│ (Router, VPN) │
│ │
│ - Windows VM │
│ │
│ (AD, DNS) │
│ │
│ │
└─────────────────────────┘
``` ```
## Integrate with your tools In this case the ESXi is configured to have it's management available through
Uplink VLAN 152 and on an internal virtual network.
- [ ] [Set up project integrations](https://git.sch.bme.hu/rlacko/maze-v2/-/settings/integrations) - VLAN 152: `10.152.211.122`
- Internal network: `192.168.1.10`
## 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/)
- [ ] [Automatically merge when pipeline succeeds](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. Other than this, VyOS is configured to have an uplink on VLAN 211.
Interfaces:
- VLAN 211: `152.66.211.122`
- Internal network: `192.168.1.254`
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. VyOS config: [vyos.md](docs/vyos.config)
## Authors and acknowledgment Windows setup:
Show your appreciation to those who have contributed to the project. - IP `192.168.1.2`
- AD & DNS
## License vCenter:
For open source projects, say how it is licensed. - IP: `192.168.1.3`
## Project status Linux Ubuntu VM (tools, debugging):
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. - IP: `192.168.1.4`
docs/vyos.config 0 → 100644
+ 404
− 0
View file @ 875ef459
firewall {
interface eth0 {
in {
name OUTSIDE-IN
}
local {
name OUTSIDE-LOCAL
}
}
log-martians enable
name OUTSIDE-IN {
default-action drop
enable-default-log
rule 10 {
action accept
state {
established enable
related enable
}
}
rule 20 {
action accept
description RDP
destination {
port 3389
}
protocol tcp_udp
state {
new enable
}
}
rule 30 {
action accept
description Linux
destination {
address 192.168.1.4
port 22
}
protocol tcp
state {
new enable
}
}
}
name OUTSIDE-LOCAL {
default-action drop
rule 10 {
action accept
state {
established enable
related enable
}
}
rule 20 {
action accept
icmp {
type-name echo-request
}
protocol icmp
state {
new enable
}
}
rule 30 {
action drop
destination {
port 22
}
protocol tcp
recent {
count 4
time minute
}
state {
new enable
}
}
rule 31 {
action accept
destination {
port 22
}
protocol tcp
state {
new enable
}
}
rule 40 {
action accept
destination {
port 1194
}
protocol udp
}
}
}
interfaces {
ethernet eth0 {
address 152.66.211.122/24
description 211-OUTSIDE
hw-id 00:0c:29:8f:54:a0
}
ethernet eth1 {
hw-id 00:0c:29:8f:54:aa
}
ethernet eth2 {
address 192.168.1.254/24
description INTERNAL-INSIDE
hw-id 00:0c:29:8f:54:b4
}
loopback lo {
}
openvpn vtun10 {
local-port 1194
mode server
openvpn-option "--proto udp"
openvpn-option "--ifconfig-pool-persist ipp.txt"
openvpn-option "--keepalive 10 120"
openvpn-option "--user nobody --group nogroup"
openvpn-option "--persist-key --persist-tun"
openvpn-option "--status openvpn-status.log"
openvpn-option "--verb 3"
openvpn-option "--mute 10"
openvpn-option "--port 1194"
openvpn-option "--dev vtun10"
openvpn-option "--cipher AES-256-CBC"
openvpn-option "--auth SHA256"
openvpn-option --client-to-client
persistent-tunnel
protocol udp
server {
domain-name maze.local
name-server 192.168.1.2
push-route 10.0.0.0/8 {
}
push-route 172.16.0.0/16 {
}
push-route 192.168.0.0/16 {
}
subnet 10.8.0.0/24
}
tls {
ca-certificate ca-1
certificate srv-1
dh-params dh-1
}
}
vti vti11 {
address 169.254.79.154/30
description gcp-peer-01
mtu 1460
}
}
nat {
destination {
rule 100 {
description RDP
destination {
address 152.66.211.122
port 3389
}
inbound-interface eth0
protocol tcp_udp
translation {
address 192.168.1.2
port 3389
}
}
rule 101 {
description Linux
destination {
address 152.66.211.122
port 10022
}
inbound-interface eth0
protocol tcp
translation {
address 192.168.1.4
port 22
}
}
}
source {
rule 100 {
outbound-interface eth0
source {
address 192.168.1.0/24
}
translation {
address masquerade
}
}
rule 101 {
outbound-interface eth0
source {
address 192.16.11.0/24
}
translation {
address masquerade
}
}
rule 110 {
outbound-interface eth0
source {
address 10.8.0.0/24
}
translation {
address masquerade
}
}
}
}
pki {
ca ca-1 {
certificate ...
private {
key ...
}
}
certificate computer {
certificate ...
private {
key ...
}
}
certificate srv-1 {
certificate ...
private {
key ...
}
}
dh dh-1 {
parameters ...
}
}
protocols {
bgp {
address-family {
ipv4-unicast {
network 10.8.0.0/24 {
}
network 192.168.1.0/24 {
}
}
}
neighbor 169.254.79.153 {
address-family {
ipv4-unicast {
soft-reconfiguration {
inbound
}
}
}
ebgp-multihop 10
remote-as 65510
timers {
holdtime 60
keepalive 20
}
}
system-as 65502
}
static {
route 0.0.0.0/0 {
next-hop 152.66.211.254 {
}
}
}
}
service {
dhcp-server {
shared-network-name LAN {
subnet 192.168.1.0/24 {
default-router 192.168.1.254
lease 86400
name-server 192.168.1.2
range 0 {
start 192.168.1.30
stop 192.168.1.60
}
}
}
}
dns {
forwarding {
allow-from 192.168.1.0/24
allow-from 10.8.0.0/24
cache-size 100
listen-address 192.168.1.254
listen-address 10.8.0.1
name-server 192.168.1.2
name-server 8.8.8.8
}
}
ssh {
port 22
}
}
system {
config-management {
commit-revisions 100
}
conntrack {
modules {
ftp
h323
nfs
pptp
sip
sqlnet
tftp
}
}
console {
device ttyS0 {
speed 115200
}
}
host-name vyos
login {
user vyos {
authentication {
public-keys laszlorafael {
key AAAAC3NzaC1lZDI1NTE5AAAAIHiR9nibdlnatDAWA5S6fI6f4O9CLvrNcmf8ihda8TJ9
type ssh-ed25519
}
public-keys rlacko {
key AAAAC3NzaC1lZDI1NTE5AAAAIPpH+TNAwcmxYc5cVctH04wUU83Pba6s/AkKXOnhDn+m
type ssh-ed25519
}
}
}
}
ntp {
allow-clients {
address 192.168.1.0/24
}
listen-address 192.168.1.254
server 0.pool.ntp.org {
}
server 1.pool.ntp.org {
}
server 2.pool.ntp.org {
}
}
syslog {
console {
facility all {
}
}
global {
facility all {
level info
}
facility protocols {
level debug
}
}
}
}
vpn {
ipsec {
esp-group ESP-TO-GCP {
lifetime 3600
pfs dh-group14
proposal ESP-1 {
encryption aes256
hash sha256
}
}
ike-group IKE-TO-GCP {
dead-peer-detection {
action restart
interval 20
timeout 80
}
key-exchange ikev2
lifetime 28800
proposal IKE-1 {
dh-group 14
encryption aes256
hash sha256
}
}
interface eth0
site-to-site {
peer left {
authentication {
mode pre-shared-secret
pre-shared-secret ...
remote-id 34.124.40.67
}
connection-type initiate
ike-group IKE-TO-GCP
local-address 152.66.211.122
remote-address 34.124.40.67
vti {
bind vti11
esp-group ESP-TO-GCP
}
}
}
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment

Hosted with :heart: by KSZK