Skip to content

Commit bfffb05

Browse files
committed
docs: Update README.md with details on how to deploy the recording uploader stack
1 parent 78f10de commit bfffb05

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,18 @@ python -m openadapt.replay VanillaReplayStrategy --instructions "calculate 9-8"
221221

222222
See https://github.com/OpenAdaptAI/OpenAdapt/tree/main/openadapt/strategies for a complete list. More ReplayStrategies coming soon! (see [Contributing](#Contributing)).
223223

224+
### Admin features
225+
If you want to self host the app, you should run the following scripts
226+
227+
**recording_uploader**
228+
- Ensure that you have valid AWS credentials added in your environment
229+
- Run the following command to create a stack on AWS that you can upload recordings to
230+
```bash
231+
python -m admin.recording_uploader.deploy
232+
```
233+
- If the script runs successfully, you should see an API Gateway URL in the output
234+
- Copy the URL and change the value of `RECORDING_UPLOAD_URL` in `openadapt/config.py` to the URL you copied
235+
224236
## Features
225237

226238
### State-of-the-art GUI understanding via [Segment Anything in High Quality](https://github.com/SysCV/sam-hq):

0 commit comments

Comments
 (0)