github/zero-ui
1
0
Fork 0
mirror of https://github.com/dec0dOS/zero-ui.git synced 2025-07-05 20:41:43 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: sync with amazing-github-template

Browse source
This commit is contained in:
dec0dOS 2021-11-10 18:13:01 +03:00
parent 1d4848ef44
commit 5c93abacc0
5 changed files with 43 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/01_BUG_REPORT.md vendored
View file

@ -20,11 +20,11 @@ latest
**Expected behavior:** **Expected behavior:**
<!-- Describe what the behavior would be without the bug. --> <!-- Describe what you expect the behavior to be without the bug. -->
**Steps to reproduce:** **Steps to reproduce:**
<!-- Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. --> <!-- Explain the steps required to duplicate the issue, especially if you are able to provide a sample application. -->
**Related code:** **Related code:**

12
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,16 +1,16 @@
<!--- Please provide a general summary of your changes in the title above --> <!--- Please provide a general summary of your changes in the title above -->
## Pull request type ## Pull Request type
<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. --> <!-- Please try to limit your pull request to one type; submit multiple pull requests if needed. -->
Please check the type of change your PR introduces: Please check the type of change your PR introduces:
- [ ] Bugfix - [ ] Bugfix
- [ ] Feature - [ ] Feature
- [ ] Code style update (formatting, renaming) - [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no api changes) - [ ] Refactoring (no functional changes, no API changes)
- [ ] Build related changes - [ ] Build-related changes
- [ ] Documentation content changes - [ ] Documentation content changes
- [ ] Other (please describe): - [ ] Other (please describe):
@ -33,8 +33,8 @@ Issue Number: N/A
- [ ] Yes - [ ] Yes
- [ ] No - [ ] No
<!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> <!-- If this does introduce a breaking change, please describe the impact and migration path for existing applications below. -->
## Other information ## Other information
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> <!-- Any other information that is important to this PR, such as screenshots of how the component looks before and after the change. -->

34
.github/labels.yml vendored
View file

@ -1,8 +1,8 @@
--- ---
- name: "breaking-change" - name: "breaking-change"
color: ee0701 color: ee0701
description: "A breaking change for existing users." description: "A change that changes the API or breaks backward compatibility for users."
- name: "bug" - name: "bugfix"
color: ee0701 color: ee0701
description: "Inconsistencies or issues which will cause a problem for users or implementors." description: "Inconsistencies or issues which will cause a problem for users or implementors."
- name: "documentation" - name: "documentation"
@ -13,10 +13,10 @@
description: "Enhancement of the code, not introducing new features." description: "Enhancement of the code, not introducing new features."
- name: "refactor" - name: "refactor"
color: 1d76db color: 1d76db
description: "Improvement of existing code, not introducing new features." description: "Updating the code with simpler, easier to understand or more efficient syntax or methods, but not introducing new features."
- name: "performance" - name: "performance"
color: 1d76db color: 1d76db
description: "Improving performance, not introducing new features." description: "Improving performance of the project, not introducing new features."
- name: "new-feature" - name: "new-feature"
color: 0e8a16 color: 0e8a16
description: "New features or options." description: "New features or options."
@ -25,41 +25,41 @@
description: "Generic maintenance tasks." description: "Generic maintenance tasks."
- name: "ci" - name: "ci"
color: 1d76db color: 1d76db
description: "Work that improves the continue integration." description: "Work that improves the continuous integration."
- name: "dependencies" - name: "dependencies"
color: 1d76db color: 1d76db
description: "Upgrade or downgrade of project dependencies." description: "Change in project dependencies."
- name: "in-progress" - name: "in-progress"
color: fbca04 color: fbca04
description: "Issue is currently being resolved by a developer." description: "Issue is currently being worked on by a developer."
- name: "stale" - name: "stale"
color: fef2c0 color: fef2c0
description: "There has not been activity on this issue or PR for quite some time." description: "No activity for quite some time."
- name: "no-stale" - name: "no-stale"
color: fef2c0 color: fef2c0
description: "This issue or PR is exempted from the stable bot." description: "This is exempt from the stale bot."
- name: "security" - name: "security"
color: ee0701 color: ee0701
description: "Marks a security issue that needs to be resolved ASAP." description: "Addressing a vulnerability or security risk in this project."
- name: "incomplete" - name: "incomplete"
color: fef2c0 color: fef2c0
description: "Marks a PR or issue that is missing information." description: "Missing information."
- name: "invalid" - name: "invalid"
color: fef2c0 color: fef2c0
description: "Marks a PR or issue that is missing information." description: "This is off-topic, spam, or otherwise doesn't apply to this project."
- name: "beginner-friendly" - name: "beginner-friendly"
color: 0e8a16 color: 0e8a16
description: "Good first issue for people wanting to contribute to the project." description: "Good first issue for people wanting to contribute to this project."
- name: "help-wanted" - name: "help-wanted"
color: 0e8a16 color: 0e8a16
description: "We need some extra helping hands or expertise in order to resolve this." description: "We need some extra helping hands or expertise in order to resolve this!"
- name: "priority-critical" - name: "priority-critical"
color: ee0701 color: ee0701
description: "This should be dealt with ASAP. Not fixing this issue would be a serious error." description: "Must be addressed as soon as possible."
- name: "priority-high" - name: "priority-high"
color: b60205 color: b60205
description: "After critical issues are fixed, these should be dealt with before any further issues." description: "After critical issues are fixed, these should be dealt with before any further issues."
@ -72,7 +72,7 @@
- name: "major" - name: "major"
color: b60205 color: b60205
description: "This PR causes a major version bump in the version number." description: "This PR causes a major bump in the version number."
- name: "minor" - name: "minor"
color: 0e8a16 color: 0e8a16
description: "This PR causes a minor version bump in the version number." description: "This PR causes a minor bump in the version number."

24
README.md
View file

@ -145,14 +145,14 @@ Advanced manual setups are also supported. Check the following environment varia
| Name | Default value | Description | | Name | Default value | Description |
| ---------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | ---------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| NODE_ENV | unset | You could learn more [here](https://nodejs.dev/learn/nodejs-the-difference-between-development-and-production) | | NODE_ENV | unset | You could learn more [here](https://nodejs.dev/learn/nodejs-the-difference-between-development-and-production) |
| LISTEN_ADDRESS | 0.0.0.0 | Express server listen address | | LISTEN_ADDRESS | `0.0.0.0` | Express server listen address |
| ZU_SERVE_FRONTEND | true | You could disable frontend serving and use ZeroUI instance as REST API for your ZeroTier controller | | ZU_SERVE_FRONTEND | `true` | You could disable frontend serving and use ZeroUI instance as REST API for your ZeroTier controller |
| ZU_SECURE_HEADERS | true | Enables [helmet](https://helmetjs.github.io) | | ZU_SECURE_HEADERS | `true` | Enables [helmet](https://helmetjs.github.io) |
| ZU_CONTROLLER_ENDPOINT | http://localhost:9993/ | ZeroTier controller API endpoint | | ZU_CONTROLLER_ENDPOINT | `http://localhost:9993/` | ZeroTier controller API endpoint |
| ZU_CONTROLLER_TOKEN | from /var/lib/zerotier-one/authtoken.secret | ZeroTier controller API token | | ZU_CONTROLLER_TOKEN | from `/var/lib/zerotier-one/authtoken.secret` | ZeroTier controller API token |
| ZU_DEFAULT_USERNAME | unset (docker-compose.yml: admin) | Default username that will be set on the first run | | ZU_DEFAULT_USERNAME | unset (`docker-compose.yml`: admin) | Default username that will be set on the first run |
| ZU_DEFAULT_PASSWORD | unset (docker-compose.yml: zero-ui) | Default password that will be set on the first run | | ZU_DEFAULT_PASSWORD | unset (`docker-compose.yml`: zero-ui) | Default password that will be set on the first run |
| ZU_DATAPATH | data/db.json | ZeroUI data storage path | | ZU_DATAPATH | `data/db.json` | ZeroUI data storage path |
ZeroUI could be deployed as a regular nodejs web application, but it requires ZeroTier controller that is installed with `zerotier-one` package. More info about the network controller you could read [here](https://github.com/zerotier/ZeroTierOne/tree/master/controller/#readme). ZeroUI could be deployed as a regular nodejs web application, but it requires ZeroTier controller that is installed with `zerotier-one` package. More info about the network controller you could read [here](https://github.com/zerotier/ZeroTierOne/tree/master/controller/#readme).
@ -234,7 +234,7 @@ First off, thanks for taking the time to contribute! Contributions are what make
2. Create your feature branch (`git checkout -b feat/amazing_feature`) 2. Create your feature branch (`git checkout -b feat/amazing_feature`)
3. Commit your changes (`git commit -m 'feat: add amazing_feature'`) 3. Commit your changes (`git commit -m 'feat: add amazing_feature'`)
4. Push to the branch (`git push origin feat/amazing_feature`) 4. Push to the branch (`git push origin feat/amazing_feature`)
5. Open a pull request 5. [Open a Pull Request](https://github.com/dec0dOS/zero-ui/compare?expand=1)
ZeroUI uses [conventional commits](https://www.conventionalcommits.org), so please follow the guidelines. ZeroUI uses [conventional commits](https://www.conventionalcommits.org), so please follow the guidelines.
Run `yarn commit` to open [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) that follows conventional commits guidelines. Run `yarn commit` to open [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface) that follows conventional commits guidelines.
@ -271,16 +271,16 @@ _For other platforms, please refer to [ZeroTier manual](https://www.zerotier.com
Reach out to me at one of the following places: Reach out to me at one of the following places:
- [GitHub discussions](https://github.com/dec0dOS/zero-ui/discussions) - [GitHub Discussions](https://github.com/dec0dOS/zero-ui/discussions)
- Email in [GitHub profile](https://github.com/dec0dOS) - Email in [GitHub profile](https://github.com/dec0dOS)
## Security ## Security
ZeroUI follows good practices of security, but 100% security can't be granted in software. ZeroUI is provided "as is" without any warranty. Use at your own risk. ZeroUI follows good practices of security, but 100% security cannot be assured. ZeroUI is provided "as is" without any warranty. Use at your own risk.
For enterprise support, a more reliable and scalable solution, please use ZeroTier Central. For enterprise support, a more reliable and scalable solution, please use ZeroTier Central.
_For more info, please refer to the [security](docs/SECURITY.md)._ _For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._
## Copyright notice ## Copyright notice

13
docs/SECURITY.md
View file

@ -2,16 +2,15 @@
## Reporting a Vulnerability ## Reporting a Vulnerability
If there are any vulnerability in **ZeroUI** project, don't hesitate to _report them_. If there are any vulnerabilities in **{{cookiecutter.project_name}}**, don't hesitate to _report them_.
1. Use any of the [contact addresses](https://github.com/dec0dOS/zero-ui#support). 1. Use any of the [private contact addresses](https://github.com/dec0dOS/zero-ui#support).
2. Describe the vulnerability. 2. Describe the vulnerability.
- If you have a fix, explain or attach it. - If you have a fix, that is most welcome -- please attach or summarize it in your message!
- In the near time, expect a reply with the required steps. Also, there may be a demand for a pull request which include the fixes.
##### You should not disclose the vulnerability publicly if you haven't received an answer in some weeks. 3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
##### If the vulnerability is rejected, you may post it publicly within some hour of rejection, unless the rejection is withdrawn within that time period. - Please **do not disclose the vulnerability publicly** until a fix is released!
##### After the vulnerability has been fixed, you may disclose the vulnerability details publicly over some days. 4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.