Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jpawlowski committed Mar 17, 2024
1 parent 1fa36b9 commit 846d513
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Azure Automation Common Runbook Framework
# https://github.com/Workoho/AzAuto-Common-Runbook-FW
# https://github.com/workoho/AzAuto-Common-Runbook-FW
setup/AzAutoFWProject/*
scripts/AzAutoFWProject/*
!scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1
Expand Down
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/Workoho/Entra-Tiering-Security-Model">
<a href="https://github.com/workoho/Entra-Tiering-Security-Model">
<img src="images/logo.svg" alt="Logo" width="180" height="180">
</a>

Expand All @@ -33,16 +33,16 @@
<p align="center">
Implement a powerful Tiering Security Model in Microsoft Entra for your Cloud Administrator identities using Azure Automation.
<br />
<a href="https://github.com/Workoho/Entra-Tiering-Security-Model/wiki"><strong>Explore the docs »</strong></a>
<a href="https://github.com/workoho/Entra-Tiering-Security-Model/wiki"><strong>Explore the docs »</strong></a>
<br />

[![Open template in GitHub Codespaces](https://img.shields.io/badge/Open%20in-GitHub%20Codespaces-blue?logo=github)](https://codespaces.new/Workoho/Entra-Tiering-Security-Model)
&nbsp;&nbsp;&nbsp;
[![View template online in Visual Studio Code](https://img.shields.io/badge/View%20Online%20in-Visual%20Studio%20Code-blue?logo=visual-studio-code)](https://vscode.dev/github/Workoho/Entra-Tiering-Security-Model)
<br />
<a href="https://github.com/Workoho/Entra-Tiering-Security-Model/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
<a href="https://github.com/workoho/Entra-Tiering-Security-Model/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
·
<a href="https://github.com/Workoho/Entra-Tiering-Security-Model/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
<a href="https://github.com/workoho/Entra-Tiering-Security-Model/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>

</p>
</div>
Expand Down Expand Up @@ -119,7 +119,7 @@ The following graphic illustrates the lifecycle concept at a high level:

## Getting Started

The entire setup is fully automatic (thanks to the amazing [Azure Automation Common Runbook Framework](https://github.com/Workoho/AzAuto-Common-Runbook-FW)), but requires some preparation and decision making to start.
The entire setup is fully automatic (thanks to the amazing [Azure Automation Common Runbook Framework](https://github.com/workoho/AzAuto-Common-Runbook-FW)), but requires some preparation and decision making to start.

[![asciicast](https://asciinema.org/a/646552.svg)](https://asciinema.org/a/646552)
_Preview of the setup procedure_
Expand Down Expand Up @@ -175,7 +175,7 @@ The following steps only need to be performed once to get you started:
$CORP='CORP'
mkdir $CORP
cd $CORP
git clone https://github.com/Workoho/Entra-Tiering-Security-Model.git $CORP.Entra-Tiering-Security-Model
git clone https://github.com/workoho/Entra-Tiering-Security-Model.git $CORP.Entra-Tiering-Security-Model
cd $CORP.Entra-Tiering-Security-Model
# Rename the Visual Studio Code workspace
Expand Down Expand Up @@ -241,10 +241,12 @@ The following steps only need to be performed once to get you started:

This file typically exists on your local machine only. It may contain parts of the configuration that you consider to be confidential for your company.

Copy the configuration template from `./config/AzAutoFwProject/AzAutoFWProject.local.psd1.tmpl` to `./config/AzAutoFwProject/AzAutoFWProject.local.psd1`:
The `Update-AzAutoFWProject.ps1` script you ran before already should have created a copy for you but you may also do this manually:

Copy the configuration template from `./config/AzAutoFwProject/AzAutoFWProject.local.template.psd1` to `./config/AzAutoFwProject/AzAutoFWProject.local.psd1`:

```powershell
copy ./config/AzAutoFWProject/AzAutoFWProject.local.psd1.tmpl ./config/AzAutoFWProject/AzAutoFWProject.local.psd1
copy ./config/AzAutoFWProject/AzAutoFWProject.local.template.psd1 ./config/AzAutoFWProject/AzAutoFWProject.local.psd1
```
Please note that by default, this configuration file is ignored by the Git repository to avoid accidential leaks of potential sensitive information.
Expand All @@ -253,6 +255,14 @@ The following steps only need to be performed once to get you started:
This file is part of your Git project repository and subject to tracking of changes. Essential parts of the configuration are done in this file where the general information is not considered a secret and its content is to be shared with everyone with access to your Git repository.
The `Update-AzAutoFWProject.ps1` script you ran before already should have created a copy for you but you may also do this manually:
Copy the configuration template from `./config/AzAutoFwProject/AzAutoFWProject.template.psd1` to `./config/AzAutoFwProject/AzAutoFWProject.psd1`:
```powershell
copy ./config/AzAutoFWProject/AzAutoFWProject.template.psd1 ./config/AzAutoFWProject/AzAutoFWProject.psd1
```
**Important:** Some parts of the configuration may be moved between the two files. However, it is not a general concept and is only supported where it is explicitly explained.
5. Open `./config/AzAutoFWProject/AzAutoFWProject.local.psd1` in your favorite editor.
Expand Down Expand Up @@ -303,6 +313,8 @@ The following steps only need to be performed once to get you started:
cd -
```
Attention: Make sure that you are actually adding the `.zip` file, _not_ the plain `.psd1` file (fans using [tab completion](https://learn.microsoft.com/en-us/powershell/scripting/learn/shell/tab-completion) might know what I mean).
Of course, you must remember the password. We recommend using a password manager to generate a long random password.
If you ever want to use this file on a different machine, you will need this password to unpack the file.
Expand Down Expand Up @@ -591,25 +603,25 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
- Julian Pawlowski - [@jpawlowski](https://github.com/jpawlowski)
Project Link: [https://github.com/Workoho/Entra-Tiering-Security-Model](https://github.com/Workoho/Entra-Tiering-Security-Model)
Project Link: [https://github.com/workoho/Entra-Tiering-Security-Model](https://github.com/workoho/Entra-Tiering-Security-Model)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge
[contributors-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/graphs/contributors
[contributors-url]: https://github.com/workoho/Entra-Tiering-Security-Model/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge
[forks-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/network/members
[forks-url]: https://github.com/workoho/Entra-Tiering-Security-Model/network/members
[stars-shield]: https://img.shields.io/github/stars/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge
[stars-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/stargazers
[stars-url]: https://github.com/workoho/Entra-Tiering-Security-Model/stargazers
[issues-shield]: https://img.shields.io/github/issues/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge
[issues-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/issues
[issues-url]: https://github.com/workoho/Entra-Tiering-Security-Model/issues
[license-shield]: https://img.shields.io/github/license/Workoho/Entra-Tiering-Security-Model.svg?style=for-the-badge
[license-url]: https://github.com/Workoho/Entra-Tiering-Security-Model/blob/master/LICENSE.txt
[license-url]: https://github.com/workoho/Entra-Tiering-Security-Model/blob/master/LICENSE.txt
[AzAutoFW]: https://img.shields.io/badge/Azure_Automation_Framework-1F4386?style=for-the-badge&logo=microsoftazure&logoColor=white
[AzAutoFW-url]: https://github.com/Workoho/AzAuto-Common-Runbook-FW
[AzAutoFW-url]: https://github.com/workoho/AzAuto-Common-Runbook-FW
[GitHubCodespaces]: https://img.shields.io/badge/GitHub_Codespaces-09091E?style=for-the-badge&logo=github&logoColor=white
[GitHubCodespaces-url]: https://github.com/features/codespaces
[VScode]: https://img.shields.io/badge/Visual_Studio_Code-2C2C32?style=for-the-badge&logo=visualstudiocode&logoColor=3063B4
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
.COMPANYNAME Workoho GmbH
.COPYRIGHT © 2024 Workoho GmbH
.TAGS
.LICENSEURI https://github.com/Workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt
.PROJECTURI https://github.com/Workoho/Entra-Tiering-Security-Model
.LICENSEURI https://github.com/workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt
.PROJECTURI https://github.com/workoho/Entra-Tiering-Security-Model
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES https://github.com/Workoho/AzAuto-Common-Runbook-FW
.EXTERNALSCRIPTDEPENDENCIES https://github.com/workoho/AzAuto-Common-Runbook-FW
.RELEASENOTES
2024-01-16 - Initial release.
#>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
.COMPANYNAME Workoho GmbH
.COPYRIGHT © 2024 Workoho GmbH
.TAGS TieringModel CloudAdministrator Identity Microsoft365 Security Azure Automation AzureAutomation
.LICENSEURI https://github.com/Workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt
.PROJECTURI https://github.com/Workoho/Entra-Tiering-Security-Model
.LICENSEURI https://github.com/workoho/Entra-Tiering-Security-Model/blob/main/LICENSE.txt
.PROJECTURI https://github.com/workoho/Entra-Tiering-Security-Model
.ICONURI
.EXTERNALMODULEDEPENDENCIES Microsoft.Graph,Microsoft.Graph.Beta,Az
.REQUIREDSCRIPTS CloudAdmin_0000__Common_0000__Get-ConfigurationConstants.ps1
.EXTERNALSCRIPTDEPENDENCIES https://github.com/Workoho/AzAuto-Common-Runbook-FW
.EXTERNALSCRIPTDEPENDENCIES https://github.com/workoho/AzAuto-Common-Runbook-FW
.RELEASENOTES
2024-01-16 - Initial release.
#>
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you believe you have found a security vulnerability or would like to suggest
**Please do not report security vulnerabilities through public GitHub issues.**

Instead, please report them to the project team by opening a security advisory here:
https://github.com/Workoho/Entra-Tiering-Security-Model/security/advisories/new
https://github.com/workoho/Entra-Tiering-Security-Model/security/advisories/new

As an alternative, you may also report them to the Workoho Security Team by email to [secure@workoho.com](mailto:secure@workoho.com). If desired, you may also encrypt your message with our PGP key; please see [Workoho's Security.txt file](https://workoho.com/.well-known/security.txt) for further details.

Expand Down
2 changes: 1 addition & 1 deletion config/AzAutoFWProject/AzAutoFWProject.template.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
GitReference = 'ModuleVersion'

# GitRepositoryUrl must be a valid Git repository URL. You likely don't want to change this unless you're forking the framework.
GitRepositoryUrl = 'https://github.com/Workoho/AzAuto-Common-Runbook-FW.git'
GitRepositoryUrl = 'https://github.com/workoho/AzAuto-Common-Runbook-FW.git'

# Files belonging to the framework are usually symlinked to the child project to keep them up to date.
# On Windows, this requires SeCreateSymbolicLinkPrivilege to be enabled, or manually running the Update-AzAutoFWProjectRunbooks.ps1 script as an administrator.
Expand Down
4 changes: 2 additions & 2 deletions scripts/AzAutoFWProject/Update-AzAutoFWProject.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
.COMPANYNAME Workoho GmbH
.COPYRIGHT © 2024 Workoho GmbH
.TAGS
.LICENSEURI https://github.com/Workoho/AzAuto-Project.tmpl/LICENSE.txt
.PROJECTURI https://github.com/Workoho/AzAuto-Project.tmpl
.LICENSEURI https://github.com/workoho/AzAuto-Project.tmpl/LICENSE.txt
.PROJECTURI https://github.com/workoho/AzAuto-Project.tmpl
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
Expand Down

0 comments on commit 846d513

Please sign in to comment.