Skip to content

Commit b7421ac

Browse files
Added configuration section to README
1 parent 095dfc8 commit b7421ac

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
# GuiStack
2-
3-
A GUI for your AWS or LocalStack environment.
2+
A web-based GUI for your AWS or LocalStack environment.
43

54
## System requirements
65
- ASP.NET Core Runtime for .NET 6.0 or newer ([Download](https://dotnet.microsoft.com/en-us/download/dotnet))
7-
- Any OS supported by the above runtime
6+
- Any operating system supported by the above runtime
7+
8+
## Configuration
9+
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.
10+
11+
| Variable name | Default value (in `run.sh`) |
12+
| ----------------------- | --------------------------- |
13+
| AWS_ACCESS_KEY_ID | localstack |
14+
| AWS_SECRET_ACCESS_KEY | localstack |
15+
| AWS_REGION | eu-central-1 |
16+
| AWS_S3_ENDPOINT_URL | http://localhost:4566 |
17+
| AWS_SQS_ENDPOINT_URL | http://localhost:4566 |
18+
| AWS_S3_FORCE_PATH_STYLE | true |
819

920
## Building
1021
Requires:
11-
- .NET 6.0 SDK or newer
22+
- .NET 6.0 SDK or newer ([Download](https://dotnet.microsoft.com/en-us/download/dotnet))
1223

1324
Optional:
1425
- Visual Studio 2022

0 commit comments

Comments
 (0)