diff --git a/assets/images/security_group.png b/assets/images/security_group.png new file mode 100644 index 000000000..de8668dea Binary files /dev/null and b/assets/images/security_group.png differ diff --git a/doc/deployment.md b/doc/DEPLOYMENT.md similarity index 100% rename from doc/deployment.md rename to doc/DEPLOYMENT.md diff --git a/doc/EC2_SELF_HOST_GUIDE.md b/doc/EC2_SELF_HOST_GUIDE.md index f8ddc5d9a..f41a7e6d1 100644 --- a/doc/EC2_SELF_HOST_GUIDE.md +++ b/doc/EC2_SELF_HOST_GUIDE.md @@ -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 ``` @@ -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:///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. @@ -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. diff --git a/doc/README.md b/doc/README.md index c33da2ade..7af03670f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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)