Documentation for a self-hosted version with nginx webserver
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 641
- Avg merge
- 12h 4m
- Merged PRs (30d)
- 57
Description
I would like a self-hosted, Docker-based version from pxt-microbit.
Wrote a default nginx configuration file:
server {
listen 80;
listen [::]:80;
server_name localhost;
root /usr/share/nginx/html;
#access_log /var/log/nginx/host.access.log main;
location / {
try_files $uri $uri/ /index.html;
}
location /static {
root /usr/share/nginx/html/docs;
}
#error_page 404 /404.html;
# redirect server error pages to the static page /50x.html
#
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
}
Makecode is runnable and /static/packages/bluetooth/icon.png file is correct (add bluetooth extension), but for ex. /api/gh/51bit/colorbit URL is missing. What am I doing wrong?
Test URL-s:
- /static/packages/bluetooth/icon.png
- /api/gh/51bit/colorbit
- /pkg/51bit/colorbit
Thanks.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No repository files or tests are named. Start by reproducing the self-hosted Docker setup with the supplied nginx configuration and checking the listed /static, /api/gh/51bit/colorbit, and /pkg/51bit/colorbit URLs; done means the documentation explains the required setup and expected behavior for all three paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, nginx, typescript
- Domain
- devops, infrastructure
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100