|
1 | 1 |
|
2 | 2 | # Getting started |
3 | 3 |
|
4 | | - |
5 | | - |
6 | | -const STORAGE = { |
7 | | - S3: "S3", |
8 | | - DOCKER_S3: 'DOCKER_S3', |
9 | | - LOCAL: "LOCAL", |
10 | | -}; |
11 | | - |
12 | | -module.exports = { |
13 | | - STORAGE, |
14 | | - ENV: { |
15 | | - PORT: process.env.MANAGER_PORT || 5001, |
16 | | - STORAGE: process.env.STORAGE || STORAGE.LOCAL, |
17 | | - |
18 | | - // process.env.AWS_ACCESS_KEY_ID, |
19 | | - // process.env.AWS_SECRET_ACCESS_KEY, |
20 | | - // process.env.AWS_DEFAULT_REGION, |
21 | | - S3_ENDPOINT: process.env.S3_ENDPOINT, |
22 | | - S3_FORCE_PATH_STYLE: process.env.S3_FORCE_PATH_STYLE, |
23 | | - S3_BUCKET: process.env.S3_BUCKET, |
24 | | - AWS_DEFAULT_REGION: process.env.AWS_DEFAULT_REGION || 'us-east-1', |
25 | | - |
26 | | - GITHUB_PERSONAL_TOKEN: process.env.GITHUB_PERSONAL_TOKEN, |
27 | | - GITHUB_MAX_REPO_SIZE: process.env.GITHUB_MAX_REPO_SIZE, |
28 | | - |
29 | | - // TODO - migrate to the new wasmer https://docs.wasmer.io/registry/get-started |
30 | | - WAPM_REGISTRY_TOKEN: false, // process.env.WAPM_REGISTRY_TOKEN, |
31 | | - |
32 | | - MANAGER_TEMPLATES: process.env.MANAGER_TEMPLATES, |
33 | | - MANAGER_MAX_PARALLEL_JOBS: process.env.MANAGER_MAX_PARALLEL_JOBS || 2, |
34 | | - MANAGER_ALLOWED_DOMAINS: process.env.MANAGER_ALLOWED_DOMAINS || 'localhost:5001', |
35 | | - |
36 | | - AUTH_MODE: process.env.AUTH_MODE || 'NO_AUTH', |
37 | | - OTOROSHI_TOKEN_SECRET: process.env.OTOROSHI_TOKEN_SECRET || 'veryverysecret', |
38 | | - OTOROSHI_USER_HEADER: process.env.OTOROSHI_USER_HEADER, |
39 | | - |
40 | | - EXTISM_RUNTIME_ENVIRONMENT: process.env.EXTISM_RUNTIME_ENVIRONMENT || false, |
41 | | - CLI_AUTHORIZATION: process.env.CLI_AUTHORIZATION, |
42 | | - CLI_AUTHORIZATION_HEADER: process.env.AUTHORIZATION_HEADER || 'Authorization', |
43 | | - |
44 | | - LOCAL_WASM_JOB_CLEANING: process.envLOCAL_WASM_JOB_CLEANING || (60 * 60 * 1000) // 1 hour |
45 | | - } |
46 | | -} |
47 | | - |
| 4 | +## Prerequisites |
| 5 | + |
| 6 | +- **Docker**: A Docker-enabled system with proper Docker access |
| 7 | + |
| 8 | +Choose a path to install Wasmo Builder: |
| 9 | +- **With a database**: Use a database to store generated Wasm binaries. Can use the Builder API for editing plugins. |
| 10 | +- **Without a database (in-memory)**: Store generated Wasm binaries on the file system. In this mode, the Builder API is unavailable but the CLI keeps running. |
| 11 | + |
| 12 | +Run the following command in your terminal to start your builder using a S3 storage: |
| 13 | + |
| 14 | +``` |
| 15 | +docker network create wasmo-network |
| 16 | +docker run -d --name s3Server \ |
| 17 | + -p 8000:8000 \ |
| 18 | + -e SCALITY_ACCESS_KEY_ID=access_key \ |
| 19 | + -e SCALITY_SECRET_ACCESS_KEY=secret \ |
| 20 | + --net wasmo-network scality/s3server |
| 21 | +docker run -d --net wasmo-network \ |
| 22 | + --name wasmo \ |
| 23 | + -p 5001:5001 \ |
| 24 | + -e "AUTH_MODE=NO_AUTH" \ |
| 25 | + -e "AWS_ACCESS_KEY_ID=access_key" \ |
| 26 | + -e "AWS_SECRET_ACCESS_KEY=secret" \ |
| 27 | + -e "S3_FORCE_PATH_STYLE=true" \ |
| 28 | + -e "S3_ENDPOINT=http://localhost:8000" \ |
| 29 | + -e "S3_BUCKET=wasmo" \ |
| 30 | + -e "STORAGE=DOCKER_S3" \ |
| 31 | + maif/wasmo |
| 32 | +``` |
| 33 | + |
| 34 | +If all goes well, Wasmo should now be serving your builder on [http://localhost:5001/](http://localhost:5001/). |
| 35 | + |
| 36 | +If you are running Docker on MacOS, you should change `S3_ENDPOINT` to `http://host.docker.internal:8000`. |
0 commit comments