-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added configuration section to README
- Loading branch information
1 parent
095dfc8
commit b7421ac
Showing
1 changed file
with
15 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,25 @@ | ||
# GuiStack | ||
|
||
A GUI for your AWS or LocalStack environment. | ||
A web-based GUI for your AWS or LocalStack environment. | ||
|
||
## System requirements | ||
- ASP.NET Core Runtime for .NET 6.0 or newer ([Download](https://dotnet.microsoft.com/en-us/download/dotnet)) | ||
- Any OS supported by the above runtime | ||
- Any operating system supported by the above runtime | ||
|
||
## Configuration | ||
GuiStack can be configured by setting various environment variables before starting the application. Most of them are provided in the `run.sh` or `run.bat` file included within the release. | ||
|
||
| Variable name | Default value (in `run.sh`) | | ||
| ----------------------- | --------------------------- | | ||
| AWS_ACCESS_KEY_ID | localstack | | ||
| AWS_SECRET_ACCESS_KEY | localstack | | ||
| AWS_REGION | eu-central-1 | | ||
| AWS_S3_ENDPOINT_URL | http://localhost:4566 | | ||
| AWS_SQS_ENDPOINT_URL | http://localhost:4566 | | ||
| AWS_S3_FORCE_PATH_STYLE | true | | ||
|
||
## Building | ||
Requires: | ||
- .NET 6.0 SDK or newer | ||
- .NET 6.0 SDK or newer ([Download](https://dotnet.microsoft.com/en-us/download/dotnet)) | ||
|
||
Optional: | ||
- Visual Studio 2022 |