diff --git a/README.md b/README.md index edd1d3ec..4b5ae5ef 100644 --- a/README.md +++ b/README.md @@ -49,15 +49,32 @@ Docker Compose is the fastest way to get Shumai running. You do not need to clon ```bash curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.yaml ``` -3. **Configure Environment Variables (Remote / Custom Port Deployments only):** - If exposing Shumai on a custom host/port combination (for example, if you change host port mapping to `12345:3000` in `docker-compose.yaml` and deploy on server `http://12.34.56.78`): - - Set `SHUMAI_SERVER_PORT: 3000` (the internal port the app starts on inside the container). - - Set `AWS_ENDPOINT_URL_S3: http://12.34.56.78:12345` (the external address including port used by client browsers to upload files). -4. Start the services in detached mode: +3. Configure environment variables (optional): + + * `SHUMAI_SERVER_PORT` controls the port the Shumai server listens on. The default is `3000`. + * By default, Shumai uses the bundled local storage service in this Docker Compose setup. To use an external S3-compatible storage instead, set `AWS_ENDPOINT_URL_S3` to the provider's endpoint URL and configure the corresponding AWS credentials and bucket settings as needed. + ``` + AWS_ENDPOINT_URL_S3: S3_ENDPOINT_URL + S3_REGION: S3_REGION + S3_BUCKET: BUCKET_NAME + S3_ACCESS_KEY_ID: ID + S3_SECRET_ACCESS_KEY: KEY + ``` + * If you use local storage and expose Shumai on a custom host/port combination, set `AWS_ENDPOINT_URL_S3` to the external URL that browsers will use to upload files. + + For example, if you change the port mapping in `docker-compose.yaml` from `3000:3000` to `12345:3000` and deploy on a server with IP address `12.34.56.78`, set: + + ```bash + AWS_ENDPOINT_URL_S3=http://12.34.56.78:12345 + ``` + + This value must be reachable from client browsers and should include the externally exposed port. + +5. Start the services in detached mode: ```bash docker compose up -d ``` -5. Open your browser and access Shumai at `http://localhost:3000` (or `http://:3000` for remote deployments). +6. Open your browser and access Shumai at `http://localhost:3000` (or `http://:3000` for remote deployments). ### Option 2: Install via NPM / Package Manager