Add docker instructions to readme

Author: calebkiage

.dockerignore

@@ -3,4 +3,8 @@
 **/.vs/
 **/.vscode/
 **/[Bb]in/
-**/[Oo]bj/
+**/[Oo]bj/
+**/*.sample.*
+tmp/
+**/.env
+**/*.md

.gitignore

@@ -573,4 +573,7 @@ FodyWeavers.xsd
 # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,visualstudio,intellij+all,dotnetcore,windows,macos,linux
 
 app-settings.*.json
-!app-settings.sample.json
+!app-settings.sample.json
+
+# docker compose mounts
+tmp/

Dockerfile

@@ -46,7 +46,7 @@ COPY --chown=mgc:mgc ./docker/* ./dist/
 RUN mkdir -p /app/.mgc /app/.local/share/.IdentityService /app/.local/share/keyrings &&\
     chmod +x /app/dist/init.sh
 
-VOLUME [ "/app/.mgc", ".local/share/.IdentityService", "/app/.local/share/keyrings" ]
+VOLUME [ "/app/.mgc", "/app/.local/share/.IdentityService", "/app/.local/share/keyrings" ]
 
 ENTRYPOINT ["./dist/init.sh"]
 

docker-compose.yml

@@ -5,4 +5,10 @@ services:
     cap_add:
     # https://man7.org/linux/man-pages/man7/capabilities.7.html
     # 
-    - IPC_LOCK # Required by gnome-keyring daemon, the dbus secret service
+    - IPC_LOCK # Required by gnome-keyring daemon, the dbus secret service
+    environment:
+      - KEYRING_PASSWORD=changeit
+    volumes:
+      - ./tmp/.mgc:/app/.mgc
+      - ./tmp/.IdentityService:/app/.local/share/.IdentityService
+      - ./tmp/keyrings:/app/.local/share/keyrings

docker/README.md

@@ -0,0 +1,34 @@
+# Microsoft Graph CLI
+## Docker Image Help
+
+### Quick start
+#### Running the container
+If you are using docker-compose:
+```sh
+$ docker-compose run -it mgc sh
+```
+
+Otherwise use docker to run the container.
+```sh
+$ docker run -it --cap-add=IPC_LOCK --rm msgraph-cli sh
+```
+
+> The IPC_LOCK capability is required by the `gnome-keyring-daemon` process which
+> performs token encryption.
+
+#### Building an image
+Set the `NUGET_USER` and `NUGET_TOKEN` environment variables to a token that has pull package access to the [microsoft](https://github.com/microsoft) and [microsoftgraph](https://github.com/microsoftgraph) GitHub organizations.
+
+To build an image in windows powershell:
+```powershell
+$ docker build \\?\$(Get-Location) -f . -t msgraph-cli --build-arg NUGET_USER=$env:NUGET_USER --build-arg NUGET_PASSWORD=$env:NUGET_TOKEN
+```
+
+> The `\\?\$(Get-Location)` section of the command is used to get around the 260 character
+> limitation on windows systems that could cause issues when copying files to the docker
+> context. This issue impacts buildkit builds. For more information, check [this issue](https://github.com/moby/buildkit/issues/1366).
+
+To build an image in linux or WSL:
+```sh
+$ docker build -t msgraph-cli --build-arg NUGET_USER=$NUGET_USER --build-arg NUGET_PASSWORD=$NUGET_TOKEN .
+```

docker/init.sh

@@ -1,5 +1,7 @@
 #!/usr/bin/env sh
 
+set -e
+
 script="$0"
 DIR="$(dirname $script)"
 
@@ -10,4 +12,4 @@ else
     echo "dbus-daemon already running"
 fi
 
-dbus-run-session -- echo "$KEYRING_PASSWORD" | gnome-keyring-daemon --daemonize --components=secrets --unlock && $@
+dbus-run-session -- echo "$KEYRING_PASSWORD" | gnome-keyring-daemon --daemonize --components=secrets --unlock && "$@"

src/app-settings.sample.json

@@ -1,8 +1,7 @@
 {
     "AuthenticationOptions": {
         "ClientId": "client id",
-        "TenantId": "tenant id",
-        "AllowUnencryptedTokenCache": false
+        "TenantId": "tenant id"
     },
     "Logging": {
         "LogLevel": {

src/msgraph-cli.csproj

@@ -14,11 +14,13 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <Content Include="app-settings.json">
-      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-    </Content>
+    <None Update="app-settings.json" CopyToOutputDirectory="Always" CopyToPublishDirectory="Always" />
   </ItemGroup>
 
+  <PropertyGroup>
+    <DefaultExcludesInProjectFolder>$(DefaultItemExcludes);**/*.sample.*</DefaultExcludesInProjectFolder>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Azure.Identity" Version="1.5.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />