diff options
author | Claudius Coenen | 2019-04-01 01:31:05 +0200 |
---|---|---|
committer | GitHub | 2019-04-01 01:31:05 +0200 |
commit | a95f1e9f560d1d869db8d4289725ac9abb0e8939 (patch) | |
tree | d049536b0662c5677d19fc4ef228c5b98ba76849 /docs/guides/s3-image-upload.md | |
parent | 3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff) | |
parent | ba6ede57bd32aae79bbcf41964777374620aeab0 (diff) |
Merge pull request #15 from ccoenen/feature/documentation-overhaul
Documentation overhaul
Diffstat (limited to '')
-rw-r--r-- | docs/guides/s3-image-upload.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md index 40ab868a..7ca8dd12 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/guides/s3-image-upload.md @@ -1,18 +1,19 @@ -# Guide - Setup CodiMD S3 image upload +Guide - Setup CodiMD S3 image upload +=== -***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* 1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket. - ![create-bucket](images/s3-image-upload/create-bucket.png) + ![create-bucket](../images/s3-image-upload/create-bucket.png) 2. Click on bucket, select **Properties** on the side panel, and find **Permission** section. Click **Edit bucket policy**. - ![bucket-property](images/s3-image-upload/bucket-property.png) + ![bucket-property](../images/s3-image-upload/bucket-property.png) 3. Enter the following policy, replace `bucket_name` with your bucket name: - ![bucket-policy-editor](images/s3-image-upload/bucket-policy-editor.png) + ![bucket-policy-editor](../images/s3-image-upload/bucket-policy-editor.png) ```json { @@ -32,15 +33,15 @@ 5. Enter user page, select **Permission** tab, look at **Inline Policies** section, and click **Create User Policy** - ![iam-user](images/s3-image-upload/iam-user.png) + ![iam-user](../images/s3-image-upload/iam-user.png) 6. Select **Custom Policy** - ![custom-policy](images/s3-image-upload/custom-policy.png) + ![custom-policy](../images/s3-image-upload/custom-policy.png) 7. Enter the following policy, replace `bucket_name` with your bucket name: - ![review-policy](images/s3-image-upload/review-policy.png) + ![review-policy](../images/s3-image-upload/review-policy.png) ```json { @@ -76,7 +77,7 @@ } ``` -9. In additional to edit `config.json` directly, you could also try [environment variable](https://github.com/codimd/server#environment-variables-will-overwrite-other-server-configs). +9. In additional to edit `config.json` directly, you could also try [environment variables](../configuration-env-vars.md). ## Related Tools |