Skip to content

Commit 8f7788f

Browse files
authored
[doc] update deployment guide (#455)
Add a note in the deployment guide to inform Linux user they must have correct permissions to use docker on their system. ### Motivation: Build instructions fail on a fresh Ubuntu installation. See this error report. #449 ### Modifications: Add a note in the deployment guide that Linux user must add their user in the `docker` group. ### Result: Hopefully, Linux users will not experience error at first use of `swift package archive`
1 parent 2669009 commit 8f7788f

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

Sources/AWSLambdaRuntimeCore/Documentation.docc/Deployment.md

+3
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ Here is the content of this guide:
6868

6969
The name of the ZIP file depends on the target name you entered in the `Package.swift` file.
7070

71+
>[!NOTE]
72+
> When building on Linux, your current user must have permission to use docker. On most Linux distributions, you can do so by adding your user to the `docker` group with the following command: `sudo usermod -aG docker $USER`. You must log out and log back in for the changes to take effect.
73+
7174
## Choosing the AWS Region where to deploy
7275

7376
[AWS Global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/) spans over 34 geographic Regions (and continuously expanding). When you create a resource on AWS, such as a Lambda function, you have to select a geographic region where the resource will be created. The two main factors to consider to select a Region are the physical proximity with your users and geographical compliance.

0 commit comments

Comments
 (0)