Skip to content

Commit f9941e1

Browse files
release: Servers101 0.1 ( Fixes #1 )
Adding CHANGELOG, Release Notes, Code of Conduct, Contribution, and Security guides.
1 parent 864f0fb commit f9941e1

File tree

8 files changed

+132
-3
lines changed

8 files changed

+132
-3
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [StartAutomating]

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Servers101 0.1:
2+
3+
* Initial Release of Servers101
4+
* An educational module with small servers in PowerShell (#1)
5+
* Built with a basic build (#2)
6+
* Including a single command: `Get-Servers101` (#3)
7+
* Initial demo servers:
8+
* `Server101` (#4)
9+
* `DebugServer` (#5)
10+
* `EventServer` (#6)
11+
* `DualEventServer` (#7)
12+

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
1-
# Servers101
2-
Simple Servers in PowerShell
1+
# Servers 101
2+
3+
Servers are pretty simple.
4+
5+
You listen and then you reply.
6+
7+
That's Servers 101.
8+
9+
## Simple Servers
10+
11+
Frameworks often abstract this away.
12+
13+
This can make the basics of servers harder to learn.
14+
15+
To avoid reliance on the framework flavor of the week, it's good to learn how to build a simple server.
16+
17+
This is a collection of simple servers in PowerShell.
18+
19+
Feel free to [contribute](contributing.md) and add your own.
20+
21+
22+
## Server Samples
23+
24+
* [DebugServer.ps1](/Servers/DebugServer.ps1)
25+
* [DualEventServer.ps1](/Servers/DualEventServer.ps1)
26+
* [EventServer.ps1](/Servers/EventServer.ps1)
27+
* [Server101.ps1](/Servers/Server101.ps1)
28+
* [SwitchServer.ps1](/Servers/SwitchServer.ps1)
29+
30+
## Using this module
31+
32+
This module has only one command, Get-Servers101.
33+
34+
It will return all of the sample servers in the module.
35+
36+
Each server will be self-contained in a single script.
37+
38+
To start the server, simply run the script.
39+
40+
To learn about how each server works, read thru each script.

README.md.ps1

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
@"
2+
# Servers 101
3+
4+
Servers are pretty simple.
5+
6+
You listen and then you reply.
7+
8+
That's Servers 101.
9+
10+
## Simple Servers
11+
12+
Frameworks often abstract this away.
13+
14+
This can make the basics of servers harder to learn.
15+
16+
To avoid reliance on the framework flavor of the week, it's good to learn how to build a simple server.
17+
18+
This is a collection of simple servers in PowerShell.
19+
20+
Feel free to [contribute](contributing.md) and add your own.
21+
22+
23+
## Server Samples
24+
25+
"@
26+
27+
28+
foreach ($serverScript in Get-Servers101) {
29+
"* [$($serverScript.Name)]($($serverScript.FullName.Substring("$pwd".Length)))"
30+
}
31+
32+
33+
34+
@"
35+
36+
## Using this module
37+
38+
This module has only one command, `Get-Servers101`.
39+
40+
It will return all of the sample servers in the module.
41+
42+
Each server will be self-contained in a single script.
43+
44+
To start the server, simply run the script.
45+
46+
To learn about how each server works, read thru each script.
47+
"@

Servers101.psd1

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,21 @@ PrivateData = @{
107107
# IconUri = ''
108108

109109
# ReleaseNotes of this module
110-
# ReleaseNotes = ''
110+
ReleaseNotes = @'
111+
## Servers101 0.1:
112+
113+
* Initial Release of Servers101
114+
* An educational module with small servers in PowerShell (#1)
115+
* Built with a basic build (#2)
116+
* Including a single command: `Get-Servers101` (#3)
117+
* Initial demo servers:
118+
* `Server101` (#4)
119+
* `DebugServer` (#5)
120+
* `EventServer` (#6)
121+
* `DualEventServer` (#7)
122+
123+
124+
'@
111125

112126
# Prerelease string of this module
113127
# Prerelease = ''

code_of_conduct.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Try to be a good person, and please be polite when providing feedback.

contributing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Anyone can contribute to this collection of simple servers.
2+
3+
There are only a few ground rules:
4+
5+
There are only a few rules here:
6+
7+
* Servers must be short (~100 lines is ideal)
8+
* Servers must be named like `*server*.ps1`
9+
* Servers must simple and mostly harmless

security.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This module is designed to help anyone understand how to build their own server.
2+
3+
Each of the educational servers in this module should run as a low-rights user on a randomized loopback port.
4+
5+
Each of the educational servers are short and easy to inspect for malicious code.
6+
7+
If you find that an educational server is being used in a malicious way or find a security issue with any of the educational servers, please file an issue.

0 commit comments

Comments
 (0)