Sunny-Moom/webvm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Copy editing

Browse Source
This commit is contained in:
Alessandro Pignotti 2023-05-19 11:02:58 +02:00
parent 145a6cfb7e
commit 4f490dc153
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/workflows/deploy.yml vendored
View File

@ -9,37 +9,37 @@ on:
inputs: inputs:
DOCKERFILE_PATH: DOCKERFILE_PATH:
type: string type: string
description: 'Absolute path to the Dockerfile.' description: 'Path to the Dockerfile'
required: true required: true
default: 'dockerfiles/debian_mini' default: 'dockerfiles/debian_mini'
IMAGE_SIZE: IMAGE_SIZE:
type: string type: string
description: 'Image size, 950M max.' description: 'Image size, 950M max'
required: true required: true
default: '600M' default: '600M'
LOGIN_UGID: LOGIN_UGID:
type: string type: string
description: 'UID:GID of the starting process.' description: 'UID:GID of the starting process'
required: true required: true
default: "1000:1000" default: "1000:1000"
DEPLOY_TO_GITHUB_PAGES: DEPLOY_TO_GITHUB_PAGES:
type: boolean type: boolean
description: 'Deploy to Github pages.' description: 'Deploy to Github pages'
required: true required: true
default: true default: true
GITHUB_RELEASE: GITHUB_RELEASE:
type: boolean type: boolean
description: 'Upload GitHub release.' description: 'Upload GitHub release'
required: true required: true
default: false default: false
GITHUB_RELEASE_TAG: GITHUB_RELEASE_TAG:
type: string type: string
description: 'Tag for the github release.' description: 'Tag for the GitHub release'
required: true required: true
default: "ext2_image" default: "ext2_image"

4
README.md
View File

@ -14,7 +14,7 @@ WebVM is powered by the CheerpX virtualization engine, and enables safe, sandbox
- Log in to Tailscale (create an account if you don't have one). - Log in to Tailscale (create an account if you don't have one).
- If you are unfamiliar with Tailscale or would like additional information see [WebVM and Tailscale](/docs/Tailscale.md). - If you are unfamiliar with Tailscale or would like additional information see [WebVM and Tailscale](/docs/Tailscale.md).
# Fork and deploy # Fork, deploy, customize
- Fork the repository. - Fork the repository.
- Enable Github pages in settings. - Enable Github pages in settings.
@ -26,6 +26,8 @@ WebVM is powered by the CheerpX virtualization engine, and enables safe, sandbox
- Accept the prompt. This is required only once to enable Actions for your fork. - Accept the prompt. This is required only once to enable Actions for your fork.
- Click on the workflow named `Deploy`. - Click on the workflow named `Deploy`.
- Click `Run workflow` and then once more `Run workflow` in the menu. - Click `Run workflow` and then once more `Run workflow` in the menu.
- Customize `dockerfiles/debian_mini` to suits your needs.
- You can also make a new Dockerfile from scratch. Use the "Path to Dockerfile" workflow parameter to select it.
<img src="/assets/fork_deploy_instructions.gif" alt="deploy_instructions_gif" width="90%"> <img src="/assets/fork_deploy_instructions.gif" alt="deploy_instructions_gif" width="90%">