Skip to content

Commit

Permalink
docs: update security_group image (AppFlowy-IO#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
speed2exe authored Nov 21, 2023
1 parent d694935 commit c1c4cd5
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 5 deletions.
Binary file added assets/images/security_group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
22 changes: 19 additions & 3 deletions doc/EC2_SELF_HOST_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ If you have any questions, please feel free to reach out to us on [Discord](http
```

2. **Configuration Setup**:
Create a `.env` file from the template. There will be values in the `.env` that needs to be change according to
your needs Kindly read the comments in `.env` file.
Create a `.env` file from the template. There will be values in the `.env` that needs to be change according to
your needs Kindly read the comments in `.env` file.
```bash
cp dev.env .env
```
Expand All @@ -95,6 +95,22 @@ If you have any questions, please feel free to reach out to us on [Discord](http
docker ps -a
```

## Post Install
### Exposing your AppFlowy-Cloud

After installing AppFlowy-Cloud, the server will be serving at port 80 (http) and 443 (http).
You might need to add Inbound Rule to expose the port.
- To do so, go to EC2 -> Instances -> your instance id -> Security -> Click on the Security Group

![Security Group Select](../assets/images/security_group.png)

- Under Inbound Rules, Click "Edit inbound rules"
- Click "Add Rule", select either http or https(if you have configured SSL Cert)
- Once done, you should be able to see the AppFlowy-Cloud admin page at `http://<your_ec2_host>/web/login`

Note: There are certain risk involved in exposing ports in your EC2 Instances, this guide is for demonstration purposes and should not be used for production.
You might want to limit IP to only trusted IP address, or use other strategies to mitigate risk.

## Configuring Environment Secrets for AppFlowy-Cloud Client

Once you've successfully set up AppFlowy Cloud on your server, the next step is to configure the environment secrets for the AppFlowy-Cloud client. These settings are crucial for the client to communicate with your self-hosted server.
Expand Down Expand Up @@ -152,7 +168,7 @@ If you're encountering difficulties redirecting to the AppFlowy application afte

2. **Apply Similar Checks for Other OAuth Providers**:
- Follow the same verification process for other OAuth providers like GitHub and Discord. Make sure their respective configurations are correctly set.

![img.png](../assets/images/env_self_host.png)

The provided image illustrates the correct configuration settings.
Expand Down
4 changes: 2 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docs
- Directory to contain information about usage and development.
- [Appflowy Cloud Deployment](./deployment.md)
- [Appflowy with Cloud](./integration.md)
- [Appflowy Cloud Deployment](./DEPLOYMENT.md)
- [Appflowy with Cloud](https://docs.appflowy.io/docs/guides/appflowy/self-hosting-appflowy)

0 comments on commit c1c4cd5

Please sign in to comment.