Skip to content

Commit

Permalink
doc: update development.md, maintainers.md and security.md (dyrector-…
Browse files Browse the repository at this point in the history
…io#844)

* dyrector-io#827 - Update development.md, maintainers.md and security.md

* Update DEVELOPMENT.md

* Update DEVELOPMENT.md

---------

Co-authored-by: Levente Orban <[email protected]>
  • Loading branch information
2 people authored and chandhuDev committed Nov 7, 2023
1 parent 800cfad commit 24fc072
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 16 deletions.
11 changes: 7 additions & 4 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,20 @@ The internal details of dyrector.io's components.
## Agent versioning

Crux considers two things to determine if an agent is outdated:
- The `AGENT_PROTO_COMPATIBILITY_MINIMUM_VERSION` in the `web/crux/shared/const.ts` file
- And the version number in Crux's `package.json`

- The `AGENT_PROTO_COMPATIBILITY_MINIMUM_VERSION` in the [web/crux/src/const.ts](./web/crux/src/shared/const.ts) file
- And the version number in [Crux's package.json](./web/crux/package.json)

When the agent version is between `AGENT_PROTO_COMPATIBILITY_MINIMUM_VERSION` and the `package.json`'s version
the agent's status will be connected, and it will be fully functional. Otherwise it going to be outdated,
and can not be used unless an update is performed.

### Releasing a new agent

While creating a new release, the `AGENT_PROTO_COMPATIBILITY_MINIMUM_VERSION` should be incremented to the version number of the new release when:
- The agent proto changed in a way that is incompatible with the old agents
- The internal working of the agent changed in a way that is incompatible with the new Crux

- The agent proto changed in a way that is incompatible with the old agents
- The internal working of the agent changed in a way that is incompatible with the new Crux

## Container labels

Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@

Please use [GitHub Issues](https://github.com/dyrector-io/dyrectorio/issues) for reporting non-security issues,
and [GitHub Discussions](https://github.com/dyrector-io/dyrectorio/discussions)
or use [Discord](https://discord.gg/pZWbd4fxga) for asking questions.
or use [Discord](https://discord.gg/pZWbd4fxga) to ask any questions.
22 changes: 11 additions & 11 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Security Policy

At dyrector.io, we consider the security of our systems a top priority. But no matter how much effort we put into system security, there can still be vulnerabilities present.
At [dyrector.io](https://dyrector.io/), we consider the security of our systems a top priority. But no matter how much effort we put into system security, there can still be vulnerabilities present.

If you discover a vulnerability, we would like to know about it so we can take steps to address it as quickly as possible. We would like to ask you to help us better protect our clients and our systems.

Please do the following:

- E-mail your findings to [email protected].
- Do not take advantage of the vulnerability or problem you have discovered, for example by downloading more data than necessary to demonstrate the vulnerability or deleting or modifying other people's data,
- Do not reveal the problem to others until it has been resolved,
- Do not use attacks on physical security, social engineering, distributed denial of service, spam or applications of third parties, and
- E-mail your findings to [[email protected]](mailto:[email protected]).
- Do not take advantage of the vulnerability or problem you have discovered, for example by downloading more data than necessary to demonstrate the vulnerability or deleting or modifying other people's data.
- Do not reveal the problem to others until it has been resolved.
- Do not use attacks on physical security, social engineering, distributed denial of service, spam or applications of third parties.
- Do provide sufficient information to reproduce the problem, so we will be able to resolve it as quickly as possible. Usually, the IP address or the URL of the affected system and a description of the vulnerability will be sufficient, but complex vulnerabilities may require further explanation.

What we promise:

- We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date,
- If you have followed the instructions above, we will not take any legal action against you in regard to the report,
- We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission,
- We will keep you informed of the progress towards resolving the problem,
- In the public information concerning the problem reported, we will give your name as the discoverer of the problem (unless you desire otherwise)
- We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date.
- If you have followed the instructions above, we will not take any legal action against you in regard to the report.
- We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission.
- We will keep you informed of the progress towards resolving the problem.
- In the public information concerning the problem reported, we will give your name as the discoverer of the problem (unless you desire otherwise).

We strive to resolve all problems as quickly as possible, and we would like to play an active role in the ultimate publication on the problem after it is resolved.

Please report security issues to `[email protected]`.
Please report security issues to [[email protected]](mailto:[email protected]).

0 comments on commit 24fc072

Please sign in to comment.