Skip to content

Improved instructions & docker permissions fix #1174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Improved instructions & docker permissions fix #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f9ce62
fix: fixed root access permissions in the Dockerfile
Souvlaki42 Aug 25, 2025
01f2ac9
feat: improved instructions
Souvlaki42 Sep 3, 2025
1fb03bd
revert: reverted dockerfile changes
Souvlaki42 Sep 10, 2025
8b8f9e2
Merge branch 'rust-lang:main' into improved-instructions
Souvlaki42 Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,35 +84,41 @@ perform tests on! Once fixed, you can choose to be credited here.
## Development

### Build the UI
```
```bash
cd ui/frontend
pnpm install
pnpm watch # Will rebuild and watch for changes
```

If you don't need the backend running because you are only making
basic HTML/CSS/JS changes, directly open in your browser the built
`ui/frontend/build/index.html`.

### Build and run the server

```
cd ui
cargo run
```

There are some optional configuration parameters described in the
[ui README](./ui/README.md) which you may set in a `.env` file. The server will
run with no configuration, but in order to load and save gists a GitHub token
must be configured.
> [!TIP]
> If you don't need the backend running because you are only making
> basic HTML/CSS/JS changes, directly open in your browser the built
> `ui/frontend/build/index.html`.

### Build or download the containers
```
```bash
cd compiler
./build.sh # If you want to test changes to the containers
./fetch.sh # If you just want the current playground
```

### Build and run the server

```bash
cd ui
cargo run
```
> [!TIP]
> There are some optional configuration parameters described in the
> [ui README](./ui/README.md) which you may set in a `.env` file. The server will
> run with no configuration, but in order to load and save gists a GitHub token
> must be configured.

> [!IMPORTANT]
> When running the server, you may see some docker warnings about missing containers. You can safely ignore them.
> You shouldn't see any docker containers running most of the time. This is normal.
> You don't need to spawn or kill any containers yourself. The backend manages that itself.

## Deployment

* [Amazon EC2 (Ubuntu)](deployment/ubuntu.md)
Expand Down
2 changes: 2 additions & 0 deletions ui/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ of choice.

### Troubleshooting

If you can't get the UI to show up outside of your network, you may need to set the `PLAYGROUND_UI_ADDRESS` environment variable to `0.0.0.0`.

#### macOS

After launching `ui`, when you try to do any action (ex. `build`, `rustfmt`, `run` and so on), you get errors from Docker about "Mounts denied":
Expand Down