diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index eb5d3c9..14be7e3 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -9,37 +9,37 @@ on: inputs: DOCKERFILE_PATH: type: string - description: 'Absolute path to the Dockerfile.' + description: 'Path to the Dockerfile' required: true default: 'dockerfiles/debian_mini' IMAGE_SIZE: type: string - description: 'Image size, 950M max.' + description: 'Image size, 950M max' required: true default: '600M' LOGIN_UGID: type: string - description: 'UID:GID of the starting process.' + description: 'UID:GID of the starting process' required: true default: "1000:1000" DEPLOY_TO_GITHUB_PAGES: type: boolean - description: 'Deploy to Github pages.' + description: 'Deploy to Github pages' required: true default: true GITHUB_RELEASE: type: boolean - description: 'Upload GitHub release.' + description: 'Upload GitHub release' required: true default: false GITHUB_RELEASE_TAG: type: string - description: 'Tag for the github release.' + description: 'Tag for the GitHub release' required: true default: "ext2_image" diff --git a/README.md b/README.md index 927cf50..3ac9793 100644 --- a/README.md +++ b/README.md @@ -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). - 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. - 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. - Click on the workflow named `Deploy`. - 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. deploy_instructions_gif