adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update rest-api.md

Browse Source 
Available description did not work for me, so I extended it.
This commit is contained in:
jonny07 2021-10-05 21:47:18 +02:00 committed by GitHub
parent 92f8f231af
commit 37df5be83f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/rest-api.md
View File

@ -35,6 +35,23 @@ Sample configuration:
},
```
Also uncommend the 2 lines below in ft_userdata/docker-compose.yml:
'''bash
ports:
- "127.0.0.1:8080:8080"
'''
Then rebuild your docker file:
Linux:
'''bash
sudo docker-compose down && sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
'''
Windows:
'''bash
docker-compose down && docker-compose pull && docker-compose build && docker-compose up -d
'''
You can now access the UI by typing 127.0.0.1:8080 in your browser. Alternatively replace the 127.0.0.1 everywhere above with your IP adress.
!!! Danger "Security warning"
By default, the configuration listens on localhost only (so it's not reachable from other systems). We strongly recommend to not expose this API to the internet and choose a strong, unique password, since others will potentially be able to control your bot.