Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add structurizr to diagramming #506

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

shoveleejoe
Copy link

@shoveleejoe shoveleejoe commented Jul 2, 2023

added structurizr to diagramming section

Thank you for taking the time to work on a PR for Awesome-Sysadmin!

To ensure your PR is dealt with swiftly please check the following:

  • Your additions are Free software
  • Software your are submitting is not your own, unless you have a healthy ecosystem with a few contributors (which aren't your sock puppet accounts).
  • Submit one item per pull request. This eases reviewing and speeds up inclusion.
  • Format your submission as follows, where Demo and Clients are optional.
    Do not add a duplicate Source code link if it is the same as the main link.
    Keep the short description under 80 characters and use sentence case
    for it, even if the project's webpage or readme uses another capitalization.
    Demo links should only be used for interactive demos, i.e. not video demonstrations.
    - [Name](http://homepage/) - Short description, under 250 characters, sentence case. ([Demo](http://url.to/demo), [Source Code](http://url.of/source/code), [Clients](https://url.to/list/of/related/clients-or-apps)) `License` `Language`
  • Additions are inserted preserving alphabetical order.
  • Additions are not already listed at awesome-selfhosted
  • The Language tag is the main server-side requirement for the software. Don't include frameworks or specific dialects.
  • You have searched the repository for any relevant issues or PRs, including closed ones.
  • Any category you are creating has the minimum requirement of 3 items.
  • Any software project you are adding to the list is actively maintained.
  • The pull request title is informative, unlike "Update README.md".
    Suggested titles: "Add aaa to bbb" for adding software aaa to section bbb,
    "Remove aaa from bbb" for removing, "Fix license for aaa", etc.

Please take some time to answer the following questions as best you can:

  • Why is it awesome?

Structurizr makes the C4 model more accessible and is easy and straightforward to use through a well-designed web interface. This simplifies the work of software, IT, and security architects and improves the usability of architectural documentation.

  • Have you used it? For how long?

I have used Structurizer for two weeks, during which time I've generated and shared the architectural diagrams for 4 solutions and 11 patterns. This cut the time to complete this work by half.

  • Is this in a personal or professional setup?

This is in a personal setup being used for professional use. Structurizr is running in a docker container in my home lab and is accessible from the Internet via a Cloudflare tunnel.

  • How many devices/users/services/... do you manage with it?

I have created 4 users in my setup using local users, I have not used the LDAP integration option.

  • Biggest pros/cons compared to other solutions?

Biggest Pro: Strucurizr adds several capabilities over other visual diagramming and diagramming-as-code tools and unifies them under one suite while maintaining a user-friendly experience.
Biggest Con: There is a learning curve to the C4 model and Structurizr expects the user to be familiar with the C4 model.

  • Any other comments about your use case, things you've found excellent, limitations you've encountered... ?

Structurizr is a web interface accessed via browser, it does not provide significant security capabilities and should be accessible only through a web application firewall.

added structurizr to diagramming section
@@ -303,6 +303,7 @@ _See also: [awesome-selfhosted/Database Management](https://github.com/awesome-s
- [Diagrams.net](https://app.diagrams.net/) - A.K.A. [Draw.io](https://app.diagrams.net/). Easy to use Diagram UI with a plethora of templates.
- [DrawThe.Net](http://go.drawthe.net/) - Javascript tool that uses a YAML-formatted input to programmatically create large, complex, and visually solid diagrams.
- [Mermaid](https://mermaid-js.github.io/mermaid-live-editor/) - Javascript module with a unique, easy, shorthand syntax. Integrates into several other tools like Grafana.
- [Structurizr](https://www.structurizr.com/) - Architecture diagramming/modelling UI for developing and collaborating on diagrams-as-code aligned to the C4 model for architecture diagrams. Facilitates workflows for creating multiple software architecture diagrams from a single model.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing several required fields (source code URL, license, language/platform), please refer to the Pull Request template and follow the recommended format.

Other entries in this section are also missing the required fields, because I did not have time to work on #416 on this section yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants