Skip to content

Commit

Permalink
Adding a section in the Readme for setting up Redis server
Browse files Browse the repository at this point in the history
  • Loading branch information
SergeiPetrovAkvelon authored and lucen-ms committed Nov 13, 2024
1 parent 6cf36d8 commit 2e7beae
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,15 @@ Both work and personal accounts use the same application for authentication. The

1. Only letters are allowed.
1. Maximum 15 characters.

## Metrics

Installation metrics allow monitoring release activity via the CLI. For detailed usage instructions, please refer to the [CLI documentation](../cli/README.md#development-parameter).

Redis is required for Metrics to work.

### Steps

1. Install Redis by following [official installation guide](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/).
1. TLS is required. Follow [official Redis TLS run guide](https://redis.io/docs/latest/operate/oss_and_stack/management/security/encryption/#running-manually).
1. Set the necessary environment variables for [Redis](./ENVIRONMENT.md#redis).
2 changes: 1 addition & 1 deletion api/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ All secrets used in the system should be handled with the utmost care. They must
It is essential to review and apply security best practices for all system components. As this setup is minimal, it is the customer’s responsibility to harden the system for production use.

- [Azure Storage Security Recommendations](https://learn.microsoft.com/en-us/azure/storage/blobs/security-recommendations)
- [Azure WebApp Security Best Practices](https://learn.microsoft.com/en-us/azure/app-service/overview-security)
- [Azure WebApp Security Best Practices](https://learn.microsoft.com/en-us/azure/app-service/overview-security)

0 comments on commit 2e7beae

Please sign in to comment.