Compare commits

...
168 Commits
Author SHA1 Message Date
Justin Lin 8cc006e3a4 fix: check files using abs path (#175)
the docker user is changed from commander to root due to #168 pr.
Use absolute path instead of relative path to prevent false detection.
2025-02-15 20:55:03 +08:00
Justin Lin d6ae6d818d Fix network (#174) 2025-02-15 20:52:25 +08:00
wancat 6692ae2b9b fix: check files using abs path
(the docker user is changed due to feat-ssh pr)
2025-02-15 20:42:50 +08:00
Justin Lin fab02d03a9 fix: update env samples, use dash only for naming networks 2024-12-27 21:01:31 +08:00
Justin Lin 9e44ebe415 fix: remove unwanted error logging 2024-12-27 20:56:23 +08:00
Justin Lin 019caf58e4 fix: use a different docker network for dev to prevent "interna" settings conflicts 2024-12-27 20:56:05 +08:00
Justin Lin 97ad1a7b50 fix: set mongodb version to 6 (#170) 2024-10-21 13:51:17 +08:00
Justin Lin cb4b9f429a fix: set mongodb version to 6 2024-10-21 13:43:58 +08:00
Justin Lin 5e11d2da11 fix: pass env file to containers directly (#169) 2024-10-21 12:59:56 +08:00
Justin Lin a901ce005c fix: pass env file to containers directly 2024-10-21 12:53:39 +08:00
Justin Lin 4dd2a7cbe1 Feat ssh (#168) 2024-10-21 12:15:43 +08:00
Justin Lin 5cf375905d feat: remove debug logs 2024-10-21 12:12:52 +08:00
Justin Lin d7c5c756f3 feat: add production env sample 2024-10-21 12:11:32 +08:00
Justin Lin 44ecd3b87a fix: mounting quest home into production container 2024-10-21 12:11:24 +08:00
Justin Lin 1888781a47 fix: copy entrypoint into quest container. Disable mounting for entrypoint & public key. Use Env to pass ssh public key into container. 2024-10-21 11:54:32 +08:00
Justin Lin 860b257ea7 doc: update Windows setup guide 2024-10-20 20:06:39 +08:00
Justin Lin ba251fb933 feat: update dump script 2024-10-17 22:08:52 +08:00
Chen, Tai-Lin 84bd2620d8 docs: add windows environment setup document draft 2024-10-16 23:53:58 +08:00
Justin Lin b449d84c54 feat: auto create config folder and player network 2024-10-16 14:13:41 +08:00
Justin Lin 91ebaec22c feat: update document and remove some debug logging 2024-10-14 18:32:02 +08:00
Justin Lin 58354b7cd8 feat: clean up /etc/skel and move ssh key to /etc/ssh/authorized_keys/ 2024-10-14 17:48:05 +08:00
Justin Lin 31301419ad feat: add ssh connection retry 2024-10-14 17:31:35 +08:00
Justin Lin 251139c159 feat: move sshd_config to .include folder 2024-10-14 17:31:23 +08:00
Justin Lin a4ed4cf533 feat: remove unnecessary quest Dockerfiles 2024-10-14 12:40:53 +08:00
Justin Lin 247f03b71a feat: mount quest home to /etc/skel to prevent building images 2024-10-14 12:30:28 +08:00
Justin Lin be22a121c8 feat: use entrypoint to create user account and copy ssh key 2024-10-14 12:06:05 +08:00
Justin Lin 261c6fc029 feat: generate key pair using ssh2 for right public key format 2024-10-14 11:34:53 +08:00
Justin Lin 03b2993b56 feat: load or create key 2024-10-14 11:23:25 +08:00
Justin Lin 2cc348687a feat: generate key pair function 2024-10-14 10:53:15 +08:00
Justin Lin 2a3429106c feat: remove welcome banner 2024-10-13 16:31:17 +08:00
Justin Lin a6720cfe39 feat: connect through ssh 2024-10-13 15:59:01 +08:00
Justin Lin 4c292fd6ba wip: allow connection from docker container 2024-10-13 15:05:20 +08:00
Justin Lin 5ba0021c37 fix: ssh server 2024-10-10 22:43:39 +08:00
Justin Lin 19897e607f wip: connect container through ssh 2024-10-10 20:54:42 +08:00
Justin Lin 08e9191c4b feat: replace alpine with debian slim 2024-10-10 20:54:09 +08:00
Justin Lin aa95eda23c Doc (#167) 2024-10-10 19:52:04 +08:00
Justin Lin 6bc37900d8 doc: update README 2024-10-10 17:41:47 +08:00
Justin Lin 98f18627e5 feat: mount quest 2024-10-10 17:21:38 +08:00
Justin Lin 9b4f50ebbd Formbricks (#157)
add quest feedback and bug report form using Formbricks
2024-08-02 22:07:36 +08:00
wancat 5fd24190d2 feat: change form to production 2024-08-02 21:17:18 +08:00
wancat d2bb079f50 feat: add bug report 2024-08-02 20:54:38 +08:00
wancat d959ab22fe refactor: move open survey to formbricks 2024-08-02 16:49:26 +08:00
wancat 9c8260a411 feat: integrate form after finishing quest 2024-08-02 16:15:06 +08:00
wancat 3c92c9d143 feat: add formbricks 2024-08-02 15:32:47 +08:00
raygur 5208d87bd6 feat: formbricks editing 2024-08-02 14:44:28 +08:00
RayGur 634464065d feat: formbricks edit 2024-08-02 14:44:28 +08:00
RayGur 4c90793fc6 feat: formbricks init 2024-08-02 14:44:28 +08:00
RayGur 169587c54d feat: formbricks setup 2024-08-02 14:41:14 +08:00
Justin Lin 4dd5f94c60 fix: map background (#156)
Put catelog background to public folder
2024-08-02 14:36:38 +08:00
Justin Lin 14bcb3b0d5 Basic checkpoint quests (#155) 2024-08-02 14:35:32 +08:00
Annie Huang 8281a9d882 fix: map background 2024-08-02 13:19:53 +08:00
Chen, Tai-Lin dcf72d046c quest: fix checkpoint-03 2024-08-02 11:12:30 +08:00
Chen, Tai-Lin b73607fb8d quest: fix checkpoint-02 bug 2024-08-02 10:45:31 +08:00
Chen, Tai-Lin b64d707d16 quest: fix checkpoints bug 2024-08-02 10:22:42 +08:00
Chen, Tai-Lin 7dcac306f9 quest: checkpoint03 2024-08-02 02:27:41 +08:00
Chen, Tai-Lin eddbda23d7 quest: fix content in remove 2024-08-02 01:06:05 +08:00
Chen, Tai-Lin 124c5cc401 quest: checkpoint-02 2024-08-02 01:05:38 +08:00
Chen, Tai-Lin 21d08b8156 quest: checkpoint01 2024-08-02 00:28:59 +08:00
Chen, Tai-Lin 3745011504 fix quest content 2024-08-01 21:57:43 +08:00
Justin Lin 3f08452ea4 feat: 119-Quest-Intro (#154)
- Add an introduction for every quest
- Not yet written documents for the introduction, so the contents are
from the information in the game
2024-08-01 20:52:10 +08:00
Annie Huang acfb09c6ca delete redundant code 2024-08-01 19:58:13 +08:00
Annie Huang c2c100e6e6 simplify data usage 2024-08-01 19:55:24 +08:00
Annie Huang 4033eefa0d remove redundant variable 2024-08-01 19:41:55 +08:00
Annie Huang 334b34ef65 Green button for unlocked and completed quest 2024-08-01 19:40:17 +08:00
Annie Huang ac89d521fc remove console log 2024-08-01 19:32:28 +08:00
Annie Huang 60641ba0ad change background loading method 2024-08-01 19:29:01 +08:00
Annie Huang dd67bcb1bd Add: Quest Introduction 2024-08-01 19:11:27 +08:00
Justin Lin d002b21aa8 Feat map (#152) 2024-07-31 20:37:49 +08:00
wancat 033c808c02 chore: remove echarts dependency 2024-07-31 18:25:01 +08:00
wancat 1be4f73e7e refactor: styles of nodes and edges 2024-07-31 18:17:44 +08:00
wancat 9ddfcd2a86 feat: add edges (straight line for now) 2024-07-31 18:11:18 +08:00
wancat ca36f6391a feat: add dragging 2024-07-31 18:00:19 +08:00
wancat 1572b2ea06 feat: rewrite map state handling 2024-07-31 17:54:59 +08:00
wancat 8f6914d46c feat: new map by svg 2024-07-31 17:12:43 +08:00
Justin Lin 517ab43e8c Execute Quest (#150) 2024-07-31 16:37:32 +08:00
Justin Lin 74c49e1df7 Quest tab (#151) 2024-07-31 16:37:17 +08:00
wancat cb0f3cc3b0 fix: hint instruction 2024-07-31 08:46:50 +08:00
Chen, Tai-Lin 5605b27127 modify quests' text 2024-07-30 23:43:23 +08:00
wancat a7368110dd feat: update quest requirements to include tab 2024-07-29 22:19:32 +08:00
wancat bdb7def73a feat: finish tab quest 2024-07-29 22:16:58 +08:00
wancat b74866e50f wip: tab 2024-07-28 15:14:56 +08:00
wancat d577656eb1 feat: allow testing on creating new session 2024-07-28 15:14:45 +08:00
Lin, Hung-Shin 6400aa4a56 Style: Add file/folder icon in file tree (#149) 2024-07-28 12:22:59 +08:00
wancat 887d205ec1 quest: execute 2024-07-26 16:25:38 +08:00
wancat 8597c22b9f wip: execute tutorial content 2024-07-23 18:37:52 +08:00
Chen, Tai-Lin d8c0ee4b20 style: add file/folder icon and modify some style in visualization part 2024-07-23 18:30:57 +08:00
Chen, Tai-Lin 8180e9a0cf delete unused text 2024-07-23 12:15:03 +08:00
Chen, Tai-Lin 6daa11bff7 fix: start buttom languege issue 2024-07-23 11:20:56 +08:00
Chen, Tai-Lin 976dc6363c fix: wrong answer in answer.sh 2024-07-23 10:29:50 +08:00
Lin, Hung-Shin 8d0a210f0e Fix current quests (#144) 2024-07-03 08:15:18 +08:00
wancat c38104d043 fix: typo 2024-07-03 08:09:57 +08:00
wancat 83e563ab56 fix: requirement in get-started 2024-07-03 08:05:58 +08:00
wancat fa2059814c fix: increase line height in description part 2024-07-03 08:05:40 +08:00
Chen, Tai-Lin f9fa5a2102 fix: update quest [remove] 2024-07-03 01:57:39 +08:00
Chen, Tai-Lin 8ed6acbcc1 fix: update quest [move] 2024-07-03 01:47:59 +08:00
Chen, Tai-Lin d2452c91a6 fix: update quest [copy] 2024-07-03 01:42:37 +08:00
Chen, Tai-Lin 5bac9ce099 style: revise description part 2024-07-03 01:25:34 +08:00
Chen, Tai-Lin 2aaff0f7bc fix: quests exceptions 2024-07-03 01:10:59 +08:00
Chen, Tai-Lin 96ab39437b fix: quest error [remove] 2024-07-03 01:02:15 +08:00
Chen, Tai-Lin d6b606e807 fix: update quest [get-started] 2024-07-03 01:01:30 +08:00
Chen, Tai-Lin b792992391 fix: update quest [explore] 2024-07-03 01:01:30 +08:00
Chen, Tai-Lin 922100d8da fix: update quest [cast] 2024-07-03 01:01:30 +08:00
Chen, Tai-Lin 52597e8c5e fix: update quest [explore] 2024-07-03 01:01:30 +08:00
Chen, Tai-Lin a6c160ac0e fix: update quest [cast] 2024-07-03 01:00:33 +08:00
Chen, Tai-Lin 3859403b56 fix: revise quest content [get-started] (1 to be fixed) 2024-07-03 01:00:17 +08:00
Chen, Tai-Lin 2a29b0b8ac fix: update quest [read] 2024-07-03 00:57:33 +08:00
Chen, Tai-Lin aaa97e0dca fix: update quest [path] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 3a28af0a67 fix: update quest [move] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 551d502845 fix: update quest [helloworld] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 3f0191112d fix: update quest [get-started] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin d565709a59 fix: update quest [explore] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 435a426f5b fix: update quest [remove] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 377afb3078 fix: update quest [create] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 9d26951978 fix: update quest [cast] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin db3b00f8ee fix: update quest [copy] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin c09c4ff9e0 fix: quests exceptions error 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin b3b374b3cd fix: update quest [explore] 2024-07-03 00:53:56 +08:00
Chen, Tai-Lin 5ca187651d fix: update quest answer file [get-started] 2024-07-03 00:53:55 +08:00
Chen, Tai-Lin f2ca4a26ac fix: update quest's exceptions 2024-07-03 00:53:55 +08:00
Chen, Tai-Lin 462f17a779 fix: update quest [cast] 2024-07-03 00:53:55 +08:00
Chen, Tai-Lin 3deabb25a9 fix: update quest [get-started] 2024-07-03 00:53:55 +08:00
Chen, Tai-Lin 3dad7ddccb fix: revise quest content [get-started] (1 to be fixed) 2024-07-03 00:53:55 +08:00
Chen, Tai-Lin 25888a1465 fix: modify component name and title (HintPart=>DescriptionPart) 2024-07-03 00:53:55 +08:00
Chen, Tai-Lin 3559814f55 fix: quest error [remove] 2024-07-03 00:44:30 +08:00
Chen, Tai-Lin 8142ff816c Merge branch 'fix-current-quests' of https://github.com/lancatlin/linux-odyssey into fix-current-quests 2024-07-03 00:34:39 +08:00
Chen, Tai-Lin 9c160253c9 fix: update quest [read] 2024-07-03 00:34:33 +08:00
Chen, Tai-Lin 80e1a40b6e fix: update quest [path] 2024-07-03 00:34:33 +08:00
Chen, Tai-Lin 2b70f3c7cd fix: update quest [move] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 2e29919ad9 fix: update quest [helloworld] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin ca79042a3b fix: update quest [get-started] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin c8d2320bf5 fix: update quest [explore] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 441909efd5 fix: update quest [remove] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 90e3fc2bd0 fix: update quest [create] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 598141d735 fix: update quest [cast] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin e11432be45 fix: update quest [copy] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 2c1fe7bb96 fix: quests exceptions error 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 8c54bfe192 fix: update quest [explore] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin d292195302 fix: update quest answer file [get-started] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 6bbf70a258 fix: update quest's exceptions 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 526b856de7 fix: update quest [cast] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 1a20ffb295 fix: update quest [get-started] 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 4efa9b8831 fix: revise quest content [get-started] (1 to be fixed) 2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 3944e91d0c fix: modify component name and title (HintPart=>DescriptionPart) 2024-07-03 00:34:32 +08:00
wancat c30b4a7c6e feat: add isGuest migration script 2024-07-03 00:34:32 +08:00
wancat 14cd16b611 feat: add isGuest field in user model 2024-07-03 00:34:32 +08:00
wancat b07b60f6bd feat: add register guest button 2024-07-03 00:34:32 +08:00
wancat 9d1bed7543 feat: add register-guest api 2024-07-03 00:34:32 +08:00
wancat 715352f77c feat: install date-fns 2024-07-03 00:34:32 +08:00
Annie Huang c4550a395a fix map view 2024-07-03 00:34:32 +08:00
dependabot[bot] 5795cb16b8 build(deps): bump tar from 6.2.0 to 6.2.1
Bumps [tar](https://github.com/isaacs/node-tar) from 6.2.0 to 6.2.1.
- [Release notes](https://github.com/isaacs/node-tar/releases)
- [Changelog](https://github.com/isaacs/node-tar/blob/main/CHANGELOG.md)
- [Commits](https://github.com/isaacs/node-tar/compare/v6.2.0...v6.2.1)

---
updated-dependencies:
- dependency-name: tar
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-07-03 00:34:32 +08:00
Chen, Tai-Lin 691a6dcb25 fix: update quest [read] 2024-07-03 00:32:04 +08:00
Chen, Tai-Lin 979ea72f3a fix: update quest [path] 2024-07-03 00:31:57 +08:00
Chen, Tai-Lin f9e40edb8a fix: update quest [move] 2024-07-03 00:31:46 +08:00
Chen, Tai-Lin 276bfee5ed fix: update quest [helloworld] 2024-07-03 00:31:40 +08:00
Chen, Tai-Lin f03c359f89 fix: update quest [get-started] 2024-07-03 00:31:30 +08:00
Chen, Tai-Lin 7db08a5cda fix: update quest [explore] 2024-07-03 00:31:20 +08:00
Chen, Tai-Lin b19f0da678 fix: update quest [remove] 2024-07-03 00:31:10 +08:00
Chen, Tai-Lin c87eef233c fix: update quest [create] 2024-07-03 00:30:59 +08:00
Chen, Tai-Lin dabc40eb1e fix: update quest [cast] 2024-07-03 00:30:44 +08:00
Chen, Tai-Lin 0efe2235f8 fix: update quest [copy] 2024-07-03 00:30:37 +08:00
Chen, Tai-Lin 9d45993d0d fix: quests exceptions error 2024-07-02 22:32:00 +08:00
Chen, Tai-Lin 79f9cb3e95 fix: update quest [explore] 2024-07-02 02:09:09 +08:00
Chen, Tai-Lin 47c7ff04a9 fix: update quest answer file [get-started] 2024-07-02 00:49:42 +08:00
Chen, Tai-Lin f831f4d4e5 fix: update quest's exceptions 2024-07-01 23:39:58 +08:00
Chen, Tai-Lin 29799faa79 fix: update quest [cast] 2024-07-01 23:10:46 +08:00
Chen, Tai-Lin 2727c9f4bb fix: update quest [get-started] 2024-07-01 22:38:42 +08:00
Chen, Tai-Lin 9ed726d597 fix: revise quest content [get-started] (1 to be fixed) 2024-06-28 02:25:34 +08:00
Chen, Tai-Lin fcb52b9d9e fix: modify component name and title (HintPart=>DescriptionPart) 2024-06-28 02:14:22 +08:00
97 changed files with 5623 additions and 2493 deletions

No files matched your search

+50
View File
@@ -0,0 +1,50 @@
HOST=localhost
PORT=3000
BASE_URL=https://example.com
SECRET_KEY=YOU_SHOULD_CHANGE_THIS
BACKEND_URL=http://backend:3000
DOCKER_NETWORK=linux-odyssey-players
MONGO_ROOT_PASSWORD=adminpassword
MONGO_USER=commander
MONGO_PASS=commander
MONGO_DB=linux-odyssey
MONGO_URL=mongodb://commander:commander@db:27017/linux-odyssey
# Admin user credentials for analytics
ADMIN_USERNAME=admin
ADMIN_PASSWORD=admin
ADMIN_HOST=0.0.0.0
ADMIN_PORT=3001
# ADMIN_BASE_URL=http://0.0.0.0:3001
# Optional
# CONTAINER_EXPIRY=60 # 60 minutes
# SESSION_MAX_AGE=168 # 7 days
# TRUSTED_PROXIES=1.2.3.4
# valid configurations see isIP & isIPRange in https://github.com/validatorjs/validator.js?tab=readme-ov-file#validators
# GOOGLE_CLIENT_ID=
# GOOGLE_CLIENT_SECRET=
# GITHUB_CLIENT_ID=
# GITHUB_CLIENT_SECRET=
# SURVEY_URL=
# BUG_REPORT_URL=
# SURVEY_URL=
# BUG_REPORT_URL=
# Docker related config
# DOCKER_NETWORK=host
# QUEST_IMAGE=linuxodyssey/quest-base
# DOCKER_PREFIX=linuxodyssey/quest-
# To mount quest folder from host into container, for development purpose
# MOUNT_QUEST=true
# LOG_PATH=
# Testing, create a user with the following credentials, disable rate limiting
# TESTING=true
# TESTING_USERNAME=alex
# TESTING_PASSWORD=Alex1234
+38
View File
@@ -0,0 +1,38 @@
HOST=localhost
PORT=3000
BASE_URL=http://localhost:5173
MONGO_URL=mongodb://localhost:27017/odyssey-test
SECRET_KEY=sample-secret
DOCKER_NETWORK=linux-odyssey-players-dev
# Optional
# BACKEND_URL=http://host.docker.internal:3000
# CONTAINER_EXPIRY=60 # 60 minutes
# SESSION_MAX_AGE=168 # 7 days
# TRUSTED_PROXIES=1.2.3.4
# valid configurations see isIP & isIPRange in https://github.com/validatorjs/validator.js?tab=readme-ov-file#validators
# GOOGLE_CLIENT_ID=
# GOOGLE_CLIENT_SECRET=
# GITHUB_CLIENT_ID=
# GITHUB_CLIENT_SECRET=
# SURVEY_URL=
# BUG_REPORT_URL=
# SURVEY_URL=
# BUG_REPORT_URL=
# Docker related config
# DOCKER_NETWORK=host
# QUEST_IMAGE=linuxodyssey/quest-base
# DOCKER_PREFIX=linuxodyssey/quest-
# To mount quest folder from host into container, for development purpose
# MOUNT_QUEST=true
# LOG_PATH=
# Testing, create a user with the following credentials, disable rate limiting
# TESTING=true
# TESTING_USERNAME=alex
# TESTING_PASSWORD=Alex1234
+3
View File
@@ -1,3 +1,5 @@
config
# Logs
logs
*.log
@@ -85,6 +87,7 @@ built
.env.test.local
.env.production.local
.env.local
.env.prod
# parcel-bundler cache (https://parceljs.org/)
.cache
+105 -76
View File
@@ -5,9 +5,15 @@
## Requirements
- NodeJS
- NodeJS v20+
- Docker
- Yarn
- Yarn: v1.22
## Known Issues
- MongoDB requires x86 architecture to run for v5+ versions. You can track [this issue](https://github.com/linux-odyssey/linux-odyssey/issues/166) for updates.
Windows user please refer to [docs/windows-setup.md](docs/windows-setup.md) for setup instructions.
## Installation
@@ -15,30 +21,66 @@
cd linux-odyssey
yarn install
## Development
## Project Structures
Run mongoDB first:
1. **app**: frontend
2. **server**: backend
3. **quests**: tutorials scripts for each quest
4. **packages**: other packages
1. **analytics**: admin dashboard to analyze collected data
2. **constants**: some shared config values for app and server
3. **container**: the script run in container to capture users' command
4. **file-graph**: the algorithm to construct and modify file graph, used in both app and server
5. **models**: definitions of MondoDB collections (data schema)
6. **utils**: other utility code shared between packages
7. **game (in the future)**: core logic of game playing, will be extracted from server
## Configuration
The configuration is stored in the `.env` file. You can copy from the sample file.
cp .env.sample .env
The backend will use a SSH key pair to login to the player's container. The private key is on the host, and the public key is copied to the player's container.
The key pair is stored in `./config/ssh_key` and `./config/ssh_key.pub`. If it doesn't exist, the backend will generate a new pair and store them.
## Docker Setup
### Docker compose files explaination
1. **docker-compose.yml**: The one used for development. It sets up MongoDB and builds base quest image.
2. **docker-compose.prod.yml**: The one used for production deployment. It has a Nginx service, a backend, a database, an analytics service, and creates isolated networks for player containers.
3. **docker-compose.testing.yml**: Similar to production config, but sets up an one-time environment for end-to-end testing.
### Common Development Setup
This sets up a development database, and running development server for frontend and backend.
Pull the latest images:
docker compose pull
Start the containers:
docker compose up -d
The db will automatically restarts by Docker.
This will start the db. it will automatically restarts by Docker.
Build up dependencies:
Building quest images:
yarn build:deps
docker compose build base
yarn build:quests
Run dev server (frontend, backend):
### Build Quest Images in Details
yarn dev
In each quest folder, there is a `game.yml` file, which is the quest definition.
If you want to enable social login, you should have OAuth client token in a `.env` file:
### Build Quest Images
In each quest folder, there is a `game.yml` file, which is the quest definition. And a optional `Dockerfile` to overwrite the base image. If you want to include additional files, put them in a `home` folder. The files in `home` will **not** be copied to the image automatically, you have to copy them in the `Dockerfile`.
If you want to include additional files, put them in a `home` folder. The files in `home` will be copied to the user's home on container creation automatically.
quests/
├── Dockerfile # Base image
├── entrypoint.sh # Entrypoint for the container
├── discover
│ └── game.yml
├── helloworld
@@ -54,14 +96,55 @@ In each quest folder, there is a `game.yml` file, which is the quest definition.
└── home
└── ancient_scroll.txt
An optional `Dockerfile` can overwrite the base image. You can use this to install additional dependencies or modify the environment.
Customized `entrypoint.sh` for each quest is not yet supported.
To build all quests:
yarn build:quests
The base image is built with docker-compose, so you can use `docker compose build base` to rebuild it. Once you rebuild the base image, you have to rebuild all quests.
### Optional: Mounting Host Directory
To improve the development experience, we can mount the host directory to the container in the pattern:
/path/to/linux-odyssey/quests/${quest_id}/home:/home/commander
/path/to/linux-odyssey/packages/container:/usr/local/lib/container
You can edit the files on your host, and the changes will be reflected in the container. This is disabled by default. To enable it, you can set the following environment variables:
MOUNT_QUEST=true
## Development
Copy `.env.sample` to `.env` and customize it for your needs.
Build the whole project for the first time:
yarn build
This will build the typescript for each package and the server.
Run dev server (frontend, backend):
yarn dev
**IMPORTANT NOTE**: only the app and server have hot-reloading, other packages require manually running `yarn dev` in each package.
To develop analytics dashboard:
yarn analytics
The default username and password is `alex` and `Alex1234`.
## Testing
Unit tests:
yarn test:unit
Run Cypress locally, using the current development containers:
docker compose up -d
@@ -78,76 +161,22 @@ Run Cypress in container, create brand-new containers along with it:
# tearing off the containers
./docker-scripts.sh down
### Deployment
## Deployment
# Build the images (only allowed for maintainers)
docker compose -f docker-compose.prod.yml build
docker compose -f docker-compose.prod.yml push
# Server side
docker compose -f docker-compose.prod.yml pull
yarn build:quests
docker compose -f docker-compose.prod.yml up -d
### Necessary Configuration
To enable social login, you should have OAuth client token in a `.env` file:
You can copy from `example.env`
You can copy from `.env.sample`
# .env
BASE_URL=https://example.com
GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...
**YOU MUST CHANGE THE SECRET_KEY** in `.env` file.
To enable it:
docker compose --env-file .env -f docker-compose.prod.yml up -d
## Standalone App (without Docker)
Source: `app/`
# Connect to dev server (https://odyssey.wancat.cc)
yarn app
# Connect to localhost (http://localhost:3000)
yarn app:local
# Connect to anyhost
API_ENDPOINT=http://example.com yarn app:local
## Swagger
docker compose up -d swagger
Open http://localhost:8080 to open Swagger
## CLI terminal client (Docker not required)
yarn cli
Usage: client [options] [command]
Options:
-s, --session <string> Session ID
-c, --create Create a new session
-h, --host <string> Server host (default: "http://localhost:3000")
--help display help for command
Commands:
list List all sessions
connet to recent session:
yarn cli
connect to new session:
yarn cli -c
connect to specific session:
yarn cli -s 64d0de0367459c13004bc83f
connect to other host:
yarn cli -h https://example.com
list sessions:
yarn cli list
SECRET_KEY=your-secret-key
+1 -1
View File
@@ -10,6 +10,7 @@
"preview": "vite preview"
},
"dependencies": {
"@formbricks/js": "^2.1.1",
"@fortawesome/fontawesome-svg-core": "^6.4.0",
"@fortawesome/free-brands-svg-icons": "^6.4.0",
"@fortawesome/free-regular-svg-icons": "^6.4.0",
@@ -22,7 +23,6 @@
"@types/dompurify": "^3.0.5",
"axios": "^1.6.0",
"dompurify": "^3.0.6",
"echarts": "^5.4.3",
"marked": "^10.0.0",
"pinia": "^2.1.7",
"socket.io-client": "^4.7.1",
File renamed without changes.

Before

Width:  |  Height:  |  Size: 1.3 MiB

After

Width:  |  Height:  |  Size: 1.3 MiB

+15 -1
View File
@@ -20,7 +20,21 @@ function nodeClass() {
</script>
<template>
<a href="#" :class="nodeClass()">{{ node.discovered ? node.name : '???' }}</a>
<a href="#" :class="nodeClass()">
<font-awesome-icon
v-if="node.type === 'folder'"
:icon="['far', 'folder']"
class="text-text-primary size-8"
/>
<font-awesome-icon
v-else
:icon="['far', 'file']"
class="text-text-primary size-8"
/>
<br />
{{ node.discovered ? node.name : '???' }}
{{ node.name === '' && node.discovered ? '/' : '' }}
</a>
<ul :class="nodeClass()" v-if="node.children && node.children.length > 0">
<li :class="nodeClass()" v-for="child in node.children" :key="child.path">
<FileNode :node="child" :pwd="pwd" />
+3
View File
@@ -25,6 +25,9 @@ const html = computed(() => {
line-height: 1;
}
.markdown-content :deep(p) {
line-height: 1.5;
}
.markdown-content :deep(ol) {
list-style: decimal;
padding-left: 1em;
+121
View File
@@ -0,0 +1,121 @@
<script setup lang="ts">
import { useRouter } from 'vue-router'
import { useToast } from 'vue-toastification'
import { ref, defineProps, onMounted } from 'vue'
import { getQuest } from '../utils/api'
import MarkdownText from './MarkdownText.vue'
const props = defineProps({
questTitle: {
type: String,
required: true,
},
questId: {
type: String,
required: true,
},
questUnlocked: {
type: Boolean,
required: true,
},
})
const emit = defineEmits(['closeIntro'])
const showIntro = ref(true) // Controls whether the modal is visible or not
const router = useRouter()
const toast = useToast()
const { questTitle, questId, questUnlocked } = props
const questInstruction = ref('')
const questColor = ref('')
const questTextColor = ref('')
const closeModal = () => {
showIntro.value = false
emit('closeIntro', true)
router.push({ name: 'map' })
}
const handleQuests = (id: string) => {
if (questUnlocked) {
router.push({ name: 'game', params: { questId: id } })
} else {
toast.warning('你還沒完成前一個關卡!')
}
}
const handleColour = () => {
if (questUnlocked) {
questColor.value = '#00ff00'
questTextColor.value = '#000000'
} else {
questColor.value = '#505050'
questTextColor.value = '#a0a0a0'
}
}
onMounted(async () => {
const quest = await getQuest(questId)
questInstruction.value = quest.instruction
handleColour()
})
</script>
<template>
<div v-if="showIntro" class="modal">
<div class="modal-content bg-bg-secondary rounded-lg">
<span class="close text-text content-between" @click="closeModal"
>&times;</span
>
<h2
id="QuestTitle"
class="text-2xl text-text mb-5 w-full inline-flex justify-center"
>
{{ questTitle }}
</h2>
<div class="w-full h-3/5 p-8">
<div class="px-5 whitespace-pre-wrap">
<MarkdownText
class="text-text markdown-content"
:content="questInstruction"
/>
</div>
</div>
<a
id="StartAdventure"
target="_blank"
@click="handleQuests(questId)"
:style="{ backgroundColor: questColor, color: questTextColor }"
class="inline-flex justify-center rounded-lg text-base font-black py-3 mt-5 w-full text-lg"
>開始冒險</a
>
</div>
</div>
</template>
<style scoped>
.modal {
display: block;
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
background-color: rgba(0, 0, 0, 0.7);
z-index: 1;
}
.modal-content {
position: relative;
margin: 10% auto;
padding: 20px;
width: 60%;
height: 50%;
}
.close {
position: absolute;
top: 0;
right: 10px;
font-size: 30px;
cursor: pointer;
}
.markdown-content {
text-align: left;
}
</style>
+232 -159
View File
@@ -1,181 +1,254 @@
<!-- eslint-disable no-console -->
<script setup lang="ts">
import { ref, onMounted } from 'vue'
import { useRouter } from 'vue-router'
import { ref, onMounted, watch, computed } from 'vue'
import { useToast } from 'vue-toastification'
import { use, init } from 'echarts/core'
import { GraphChart } from 'echarts/charts'
import { SVGRenderer } from 'echarts/renderers'
import {
TitleComponent,
TooltipComponent,
DataZoomComponent,
} from 'echarts/components'
import { DAG } from '@linux-odyssey/utils'
import api from '../utils/api'
import { NodeImage } from '../img/svg.js'
import { getQuests } from '../utils/api'
import useUserProfile from '../store/userProfile'
import QuestIntro from './QuestIntro.vue'
const store = useUserProfile()
const marginX = 500
const marginY = 300
const chartContainer = ref(null)
let chartInstance = null
const fullwidth = window.screen.width
use([
GraphChart,
SVGRenderer,
TitleComponent,
TooltipComponent,
DataZoomComponent,
])
async function getQuests() {
try {
const res = await api.get('/quests')
return res.data
} catch (err) {
console.error(err)
throw err
}
}
const genOption = (nodes: any, edges: any) => ({
renderer: 'svg',
tooltip: {},
animationDurationUpdate: 1500,
animationEasingUpdate: 'quinticInOut',
// dataZoom: [
// {
// type: 'slider', // This type means "slider data zoom" which provides a slider bar for zooming
// orient: 'vertical', // This makes the data zoom component vertical
// start: 0, // The starting percentage of the window out of the data extent
// end: 100, // The ending percentage of the window out of the data extent
// show: true,
// },
// ],
series: [
{
type: 'graph',
layout: 'none',
symbol: () => {
return NodeImage
},
symbolSize: [fullwidth / 13, fullwidth / 30],
roam: 'move',
zoom: 1.5,
center: ['120%', '30%'],
label: {
show: true,
fontSize: fullwidth / 90,
},
edgeSymbol: ['pin', 'arrow'],
edgeSymbolSize: [2, 15],
edgeLabel: {
fontSize: 25,
},
data: nodes,
// links: [],
links: edges,
lineStyle: {
width: 3,
color: 'gray',
opacity: 4,
curveness: 0.08,
},
itemStyle: {
color: (params: any) => {
const {
data: { completed, unlocked },
} = params
if (completed) {
return '#00ff00'
}
if (unlocked) {
return '#ADADB5'
}
return '#505050'
},
},
},
],
})
function getOption(quests: any, progress: any) {
const dag = new DAG(quests)
const nodes = dag.getNodes().map((node) => ({
id: node._id,
name: node.title,
y: marginX * node.index - (marginX * dag.getLayer(node._id)) / 2,
x: marginY * node.layer * 2,
completed: progress[node._id]?.completed || false,
unlocked: node.requirements.every((req: any) => progress[req]?.completed),
}))
const lineAppearence = (node: any) => {
try {
const { unlocked } = node
return {
type: unlocked ? 'line' : 'dashed',
color: unlocked ? '#ADADB5' : '#454552',
}
} catch (err) {
console.error(err)
throw err
}
}
const edges = dag.getEdgesArray().map((edge: any) => ({
source: edge[0],
target: edge[1],
lineStyle: lineAppearence(nodes.find((node) => node.id === edge[1])),
}))
return genOption(nodes, edges)
}
const router = useRouter()
const toast = useToast()
function initChart(option: any) {
chartInstance = init(chartContainer.value)
chartInstance.setOption(option)
chartInstance.on('click', (params: any) => {
const {
data: { id, unlocked },
} = params
const svgWidth = ref(window.innerWidth)
const svgHeight = ref(window.innerHeight)
if (unlocked) {
router.push({ name: 'game', params: { questId: id } })
} else {
toast.warning('你還沒完成前一個關卡!')
}
})
const marginX = 120
const marginY = 120
const nodeWidth = 160
const nodeHeight = 50
const opened = ref<Node | null>(null)
type Node = {
id: string
title: string
x: number
y: number
index: number
completed: boolean
unlocked: boolean
}
type Edge = {
source: Node
target: Node
}
const graphData = ref<{ nodes: Node[]; edges: Edge[] }>({
nodes: [],
edges: [],
})
const isDragging = ref(false)
const dragStartX = ref(0)
const dragStartY = ref(0)
const offsetX = ref(0)
const offsetY = ref(0)
function startDrag(event: MouseEvent) {
isDragging.value = true
dragStartX.value = event.clientX - offsetX.value
dragStartY.value = event.clientY - offsetY.value
}
function drag(event: MouseEvent) {
if (!isDragging.value) return
offsetX.value = event.clientX - dragStartX.value
offsetY.value = event.clientY - dragStartY.value
}
function endDrag() {
isDragging.value = false
}
async function computeGraphData() {
if (!store.progress) return
try {
const quests = await getQuests()
const dag = new DAG(quests)
const nodesValues = dag.getNodes()
const nodes = nodesValues.map((node) => ({
id: node._id,
title: node.title,
x: marginX * node.layer * 2,
y:
marginY * node.index -
(marginX * dag.getLayer(node._id)) / 2 +
svgHeight.value / 2,
completed: store.progress[node._id]?.completed || false,
unlocked: node.requirements.every(
(req: string) => store.progress[req]?.completed
),
index: node.index,
}))
const edges = dag
.getEdgesArray()
.map((edge) => ({
source: nodes.find((n) => n.id === edge[0]),
target: nodes.find((n) => n.id === edge[1]),
}))
.filter(
(edge): edge is Edge =>
edge.source !== undefined && edge.target !== undefined
)
graphData.value = { nodes, edges }
} catch (error) {
console.error('Error computing graph data:', error)
toast.error('Failed to load quest data')
}
}
function handleNodeClick(node: Node) {
opened.value = node
}
function closeIntro(close: boolean) {
if (close) {
opened.value = null
}
}
onMounted(async () => {
await store.loadUserProfile()
const quests = await getQuests()
const option = getOption(quests, store.progress)
initChart(option)
await computeGraphData()
})
watch(() => store.progress, computeGraphData, { deep: true })
const curvedPath = computed(() => {
return (source: Node, target: Node) => {
// const dx = target.x - source.x
// const dy = target.y - source.y
// const dr = Math.sqrt(dx * dx + dy * dy)
const dr = 0
const sweep = target.index > source.index ? 0 : 1 // Determines if the arc should curve up or down based on node index
return `M${source.x},${source.y}A${dr},${dr} 0 0,${sweep} ${target.x},${target.y}`
}
})
const nodeStyle = computed(() => {
return (node: Node) => {
if (node.completed) return 'completed'
if (node.unlocked) return 'unlocked'
return 'locked'
}
})
const edgeStyle = computed(() => {
return (edge: Edge) => {
return edge.target.unlocked ? 'unlocked' : 'locked'
}
})
</script>
<template>
<div class="relative bg-black w-full h-full flex">
<img
src="../img/catelogbg.svg"
alt="bg"
class="p-2 stroke-2 scale-y-120 justify-center items-center"
/>
<h1
class="p-10 absolute w-fit z-2 font-mono flex flax-wrap text-xl"
style="width: 30%; height: 6%; font-size: 3vh; color: #00ff00"
<div
class="flex place-content-center w-full bg-catelogbg bg-cover bg-scroll"
>
踏上你的Linux冒險之旅吧!
</h1>
<div class="flex flex-wrap absolute w-full h-full z-1">
<div ref="chartContainer" class="w-full h-full flex flex-wrap"></div>
<h1
class="p-10 absolute w-fit z-2 font-mono flex flax-wrap text-xl"
style="width: 30%; height: 6%; font-size: 3vh; color: #00ff00"
>
踏上你的Linux冒險之旅吧!
</h1>
<svg
:width="svgWidth"
:height="svgHeight"
class="absolute"
@mousedown="startDrag"
@mousemove="drag"
@mouseup="endDrag"
@mouseleave="endDrag"
>
<g :transform="`translate(${offsetX}, ${offsetY})`">
<g
v-for="edge in graphData.edges"
:key="`${edge.source.id}-${edge.target.id}`"
>
<path
:d="curvedPath(edge.source, edge.target)"
:class="['edge', edgeStyle(edge)]"
/>
</g>
<g
v-for="node in graphData.nodes"
:key="node.id"
@click="handleNodeClick(node)"
>
<rect
:x="node.x - nodeWidth / 2"
:y="node.y - nodeHeight / 2"
:width="nodeWidth"
:height="nodeHeight"
rx="10"
ry="10"
:class="['node', nodeStyle(node)]"
/>
<text
:x="node.x"
:y="node.y"
text-anchor="middle"
alignment-baseline="middle"
:class="['node-text', nodeStyle(node)]"
font-size="18"
>
{{ node.title }}
</text>
</g>
</g>
</svg>
<QuestIntro
:questTitle="opened.title"
:questId="opened.id"
:questUnlocked="opened.unlocked"
v-if="opened"
@close-intro="closeIntro"
/>
</div>
</div>
</template>
<style scoped>
svg {
overflow: visible;
}
.node {
&.completed {
fill: #6cf76c;
}
&.unlocked {
fill: #8c8c92;
}
&.locked {
fill: #505050;
}
}
.node-text {
&.completed {
fill: #1d1d1d;
}
&.unlocked {
fill: #ffffff;
}
&.locked {
fill: #a0a0a0;
}
}
.edge {
stroke-width: 3;
fill: none;
&.unlocked {
stroke: #adadb5;
stroke-dasharray: none;
}
&.locked {
stroke: #454552;
stroke-dasharray: 5, 5;
}
}
</style>
+18
View File
@@ -9,9 +9,11 @@ import CompleteAnimation from '../../img/complete-animation.json'
const showModal = ref(true) // Controls whether the modal is visible or not
const router = useRouter()
const toast = useToast()
const closeModal = () => {
showModal.value = false
}
const defineComponent = () => ({
components: {
Vue3Lottie,
@@ -22,6 +24,7 @@ const defineComponent = () => ({
}
},
})
const backtoMap = async () => {
try {
router.push({ name: 'map' })
@@ -67,6 +70,21 @@ setTimeout(() => {
>回到地圖</a
>
</div>
<div style="position: relative; height: 100vh; overflow: auto">
<iframe
src="https://app.formbricks.com/s/clyffdm0c0be2wh6335clle0l"
frameborder="0"
style="
position: absolute;
left: 0;
top: 0;
width: 100%;
height: 100%;
border: 0;
"
>
</iframe>
</div>
</div>
</template>
+24 -16
View File
@@ -2,7 +2,7 @@
import { useRouter } from 'vue-router'
import { useToast } from 'vue-toastification'
import useSession from '../../store/session'
import { surveyUrl } from '../../config'
import { openBugReport, openQuestSurvey } from '../../utils/formbricks'
const router = useRouter()
const sessionStore = useSession()
@@ -21,31 +21,39 @@ const continuePlay = async () => {
</script>
<template>
<section
class="h-fit w-fit px-1 py-1 grid grid-cols-4 gap-2 place-content-between"
>
<button id="survey" class="bg-bg-secondary rounded-lg p-2">
<a title="Survey" :href="surveyUrl" target="_blank" class="h-5 w-5">
<font-awesome-icon
:icon="['fas', 'file-invoice']"
class="text-text-primary px-1"
/>
<p class="text-text-primary inline ml-1 md:flex">問卷</p>
</a>
<section class="mt-2 flex flex-row gap-3 justify-center">
<button
id="survey"
class="bg-bg-secondary rounded-lg p-2"
@click="openQuestSurvey"
>
<font-awesome-icon
:icon="['fas', 'file-invoice']"
class="text-text-primary px-1"
/>
<p class="text-text-primary inline md:flex">問卷</p>
</button>
<button disabled id="solution" class="bg-bg-disabled rounded-lg p-2">
<button
title="Bug Report"
@click="openBugReport"
class="bg-bg-secondary rounded-lg p-2"
>
<font-awesome-icon :icon="['fas', 'bug']" class="text-text-primary" />
<p class="text-text-primary inline ml-1 md:flex">回報</p>
</button>
<!-- <button disabled id="solution" class="bg-bg-disabled rounded-lg p-2">
<font-awesome-icon
:icon="['far', 'circle-question']"
class="text-text-disabled px-1"
/>
<p class="text-text-disabled inline ml-1 md:flex">解答</p>
</button>
</button> -->
<button id="reset" class="bg-bg-secondary rounded-lg p-2" @click="reset">
<font-awesome-icon
:icon="['fas', 'arrow-rotate-left']"
class="text-text-primary px-1"
/>
<p class="text-text-primary inline ml-1 hidden md:flex">重來</p>
<p class="text-text-primary inline ml-1 md:flex">重來</p>
</button>
<button
id="continue"
@@ -56,7 +64,7 @@ const continuePlay = async () => {
:icon="['far', 'circle-right']"
class="text-text-primary px-1"
/>
<p class="text-text-primary inline ml-1 hidden md:flex">繼續</p>
<p class="text-text-primary inline ml-1 md:flex">繼續</p>
</button>
</section>
</template>
@@ -37,7 +37,7 @@ const right = () => {
:icon="['far', 'lightbulb']"
class="text-yellow-200 p-2 content-center"
/>
<h1 class="inline text-text w-1/2 font-xl p-2 m-1">提示 {{ length }}</h1>
<h1 class="inline text-text w-1/2 font-xl p-2 m-1">說明</h1>
<div v-if="current !== -1" class="flex w-full justify-end items-end">
<button
class="p-2 m-1 w-1/8"
+10 -18
View File
@@ -48,14 +48,14 @@ const sessionStore = useSession()
position: absolute;
top: 0;
right: 50%;
border-top: 1px solid #00ff00;
border-top: 2px solid #00ff00;
width: 50%;
height: 20px;
}
.tree li::after {
right: auto;
left: 50%;
border-left: 1px solid #00ff00;
border-left: 2px solid #00ff00;
}
.tree li:only-child::after,
@@ -73,7 +73,7 @@ const sessionStore = useSession()
}
.tree li:last-child::before {
border-right: 1px solid #00ff00;
border-right: 2px solid #00ff00;
border-radius: 0 5px 0 0;
-webkit-border-radius: 0 5px 0 0;
-moz-border-radius: 0 5px 0 0;
@@ -89,7 +89,7 @@ const sessionStore = useSession()
position: absolute;
top: 0;
left: 50%;
border-left: 1px solid #00ff00;
border-left: 2px solid #00ff00;
width: 0;
height: 20px;
}
@@ -100,7 +100,7 @@ const sessionStore = useSession()
text-decoration: none;
color: #ffffff;
font-family: arial, verdana, tahoma;
font-size: 11px;
font-size: 12px;
display: inline-block;
border-radius: 5px;
@@ -112,18 +112,10 @@ const sessionStore = useSession()
-moz-transition: all 0.5s;
}
a.discovered {
background: #526b4e;
color: #000;
border: 1px solid #94a0b4;
}
ul.discovered,
li.discovered {
border-color: #94a0b4;
}
a.pwd {
box-shadow: 0 0 40px rgba(255, 255, 0, 20);
.tree li a.pwd {
border: 3px solid #00ff00;
background: #008080;
font-weight: bold;
font-size: 13px;
}
</style>
@@ -3,7 +3,8 @@ import { onMounted } from 'vue'
import { useRouter } from 'vue-router'
import { useToast } from 'vue-toastification'
import { logout } from '../../utils/auth'
import { bugReportUrl, surveyUrl } from '../../config'
import { surveyUrl } from '../../config'
import { openBugReport } from '../../utils/formbricks'
import useSession from '../../store/session'
import useUserProfile from '../../store/userProfile'
@@ -84,15 +85,14 @@ onMounted(async () => {
<font-awesome-icon :icon="['fas', 'map']" class="text-text-primary" />
<span class="text-text sm:hidden px-2">Map</span>
</RouterLink>
<a
<button
title="Bug Report"
:href="bugReportUrl"
target="_blank"
@click="openBugReport"
class="md:h-5 md:w-5 px-1.5 w-auto"
>
<font-awesome-icon :icon="['fas', 'bug']" class="text-text-primary" />
<span class="text-text sm:hidden px-2">Bug Report</span>
</a>
</button>
<button
title="Sign Out"
@click="handleLogout"
+32 -28
View File
@@ -3,28 +3,30 @@ import { library } from '@fortawesome/fontawesome-svg-core'
/* import specific icons */
import {
faBars,
faArrowLeft,
faList,
faGear,
faTriangleExclamation,
faExpand,
faTerminal,
faArrowRotateLeft,
faArrowRightFromBracket,
faArrowRight,
faArrowRightFromBracket,
faArrowRotateLeft,
faBars,
faBug,
faCircleExclamation,
faMap,
faTrophy,
faFileInvoice,
faEnvelope,
faExpand,
faFileInvoice,
faGear,
faList,
faMap,
faPlay,
faTerminal,
faTriangleExclamation,
faTrophy,
} from '@fortawesome/free-solid-svg-icons'
import {
faLightbulb,
faCircleQuestion,
faCircleRight,
faFile,
faFolder,
faLightbulb,
} from '@fortawesome/free-regular-svg-icons'
import {
faFacebook,
@@ -34,27 +36,29 @@ import {
/* add icons to the library */
library.add(
faBars,
faArrowLeft,
faList,
faGear,
faTriangleExclamation,
faExpand,
faTerminal,
faArrowRotateLeft,
faArrowRightFromBracket,
faArrowRight,
faArrowRightFromBracket,
faArrowRotateLeft,
faBars,
faBug,
faMap,
faTrophy,
faCircleExclamation,
faLightbulb,
faEnvelope,
faExpand,
faFileInvoice,
faGear,
faList,
faMap,
faPlay,
faTerminal,
faTriangleExclamation,
faTrophy,
faCircleQuestion,
faCircleRight,
faGithub,
faGoogle,
faFileInvoice,
faFile,
faFolder,
faLightbulb,
faFacebook,
faEnvelope,
faPlay
faGithub,
faGoogle
)
+7 -1
View File
@@ -10,9 +10,9 @@ import Toast, { POSITION } from 'vue-toastification'
/* import Vue Lottie */
import Vue3Lottie from 'vue3-lottie'
import 'vue-toastification/dist/index.css'
import App from './App.vue'
import router from './router'
import formbricks from './utils/formbricks'
const app = createApp(App)
const pinia = createPinia()
@@ -22,6 +22,12 @@ app.component('font-awesome-icon', FontAwesomeIcon)
app.use(pinia)
app.use(router)
router.afterEach(() => {
if (typeof formbricks !== 'undefined') {
formbricks.registerRouteChange()
}
})
const options = {
position: POSITION.TOP_RIGHT,
}
+7
View File
@@ -61,8 +61,15 @@ const useSession = defineStore('session', {
if (response.tasks) {
this.session.tasks = response.tasks
}
if (
response.status === 'finished' &&
this.session.status !== 'finished'
) {
this.finish()
}
this.session.status = response.status
},
finish() {},
reset() {
socket.reset()
term.reset()
+2 -2
View File
@@ -12,14 +12,14 @@ interface IProgress {
export interface UserProfile {
username: string
email: string
progress: Map<string, IProgress>
progress: Record<string, IProgress>
}
const useUserProfile = defineStore('userProfile', {
state: (): UserProfile => ({
username: '',
email: '',
progress: new Map<string, IProgress>(),
progress: {},
}),
actions: {
async loadUserProfile() {
+5
View File
@@ -43,3 +43,8 @@ export async function getActiveSession(
})
return res.data
}
export async function getQuests(): Promise<IQuest[]> {
const res = await api.get<IQuest[]>('/quests')
return res.data
}
+40
View File
@@ -0,0 +1,40 @@
import formbricks from '@formbricks/js/website'
import useSession from '../store/session'
import useUserProfile from '../store/userProfile'
if (typeof window !== 'undefined') {
formbricks.init({
environmentId: 'clzcdqqn0000kadvtqykdo0pc',
apiHost: 'https://app.formbricks.com',
})
}
export function openQuestSurvey() {
const sessionStore = useSession()
const userStore = useUserProfile()
formbricks.track('quest_completed', {
hiddenFields: {
quest: sessionStore.questId,
session: sessionStore.session?._id,
username: userStore.username,
email: userStore.email,
},
})
}
export function openBugReport() {
const sessionStore = useSession()
const userStore = useUserProfile()
formbricks.track('bug_report', {
hiddenFields: {
quest: sessionStore.questId,
session: sessionStore.session?._id,
username: userStore.username,
email: userStore.email,
},
})
}
export default formbricks
+13 -3
View File
@@ -1,22 +1,32 @@
<script setup lang="ts">
import { computed, onMounted } from 'vue'
import { computed, onMounted, watch } from 'vue'
import useSession from '../store/session'
import useUserProfile from '../store/userProfile'
import HeaderPart from '../components/header/HeaderPart.vue'
import GameHeaderComponents from '../components/header/GameHeaderComponents.vue'
import HintPart from '../components/game/HintPart.vue'
import DescriptionPart from '../components/game/DescriptionPart.vue'
import QuestPart from '../components/game/QuestPart.vue'
import TerminalPart from '../components/game/TerminalPart.vue'
import VisualizationPart from '../components/game/VisualizationPart.vue'
import ControlPalette from '../components/game/ControlPalette.vue'
import CompleteModal from '../components/game/CompleteModal.vue'
import StartButton from '../components/game/StartButton.vue'
import { openQuestSurvey } from '../utils/formbricks'
const sessionStore = useSession()
const userStore = useUserProfile()
const completed = computed(() => {
return sessionStore.session?.status === 'finished'
})
watch(completed, (newValue, oldValue) => {
if (newValue && !oldValue) {
console.log('finish', userStore)
openQuestSurvey()
}
})
const props = defineProps({
questId: {
type: String,
@@ -62,7 +72,7 @@ onMounted(async () => {
<div class="bg-bg h-full rounded-lg w-1/2">
<StartButton :questId="$props.questId" />
<section id="hint" class="h-3/5">
<HintPart />
<DescriptionPart />
</section>
<hr class="border-border border" />
<section id="terminal" class="h-2/5 overflow-hidden">
+3
View File
@@ -24,6 +24,9 @@ export default {
DEFAULT: '#FF0000',
},
},
backgroundImage: {
catelogbg: "url('/catelogbg.svg')",
},
},
},
plugins: [],
+8 -23
View File
@@ -1,4 +1,3 @@
version: '3'
services:
app:
image: linuxodyssey/frontend
@@ -29,15 +28,14 @@ services:
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- ./logs:/app/logs
- ./config:/app/config
- ./quests:/app/quests:ro
env_file:
- .env
environment:
- MONGO_URL=mongodb://${MONGO_USER}:${MONGO_PASSWORD}@db:27017/${MONGO_DB}
- DOCKER_NETWORK=linux-odyssey-players
- SECRET_KEY=${SECRET_KEY}
- TRUSTED_PROXIES=${TRUSTED_PROXIES}
- BACKEND_URL=http://backend:3000
- BASE_URL=${BASE_URL}
- HOST_PROJECT_ROOT=${PWD}
analytics:
image: linuxodyssey/analytics
@@ -52,13 +50,11 @@ services:
- internal
ports:
- '3001:3001'
environment:
- MONGO_URL=mongodb://${MONGO_USER}:${MONGO_PASSWORD}@db:27017/${MONGO_DB}
- ADMIN_USERNAME=${ADMIN_USERNAME}
- ADMIN_PASSWORD=${ADMIN_PASSWORD}
env_file:
- .env
db:
image: mongo
image: mongo:6
restart: always
networks:
- internal
@@ -67,19 +63,8 @@ services:
volumes:
- mongo:/data/db
- ./mongo-init.js:/docker-entrypoint-initdb.d/mongo-init.js:ro
environment:
- BASE_URL=${BASE_URL}
- MONGO_INITDB_ROOT_USERNAME=admin
- MONGO_INITDB_ROOT_PASSWORD=${MONGO_ROOT_PASSWORD}
- MONGO_USER=${MONGO_USER}
- MONGO_PASS=${MONGO_PASSWORD}
- MONGO_DB=${MONGO_DB}
- GOOGLE_CLIENT_ID=${GOOGLE_CLIENT_ID}
- GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
- GITHUB_CLIENT_ID=${GITHUB_CLIENT_ID}
- GITHUB_CLIENT_SECRET=${GITHUB_CLIENT_SECRET}
- SURVEY_URL=${SURVEY_URL}
- BUG_REPORT_URL=${BUG_REPORT_URL}
env_file:
- .env
base:
image: linuxodyssey/quest-base
+8 -4
View File
@@ -1,7 +1,7 @@
version: '3'
services:
db:
image: mongo
image: mongo:6
restart: always
networks:
- internal
@@ -12,12 +12,16 @@ services:
base:
image: linuxodyssey/quest-base
networks:
- players-dev
build:
context: .
dockerfile: ./quests/Dockerfile
extra_hosts:
- 'host.docker.internal:host-gateway'
networks:
internal:
players:
name: linux-odyssey-players
internal: true
players-dev:
name: linux-odyssey-players-dev
internal: false
+4 -3
View File
@@ -32,15 +32,16 @@ down() {
dump() {
# Define service name and dump directory name
SERVICE_NAME="db"
COMPOSE_FILE="docker-compose.prod.yml"
DUMP_NAME="mongodump-$(date --iso).archive"
CONTAINER_ID=$(docker compose ps -q $SERVICE_NAME)
CONTAINER_ID=$(docker compose -f $COMPOSE_FILE ps -q $SERVICE_NAME)
# Fetch credentials from Docker environment variables
MONGO_URL=$(docker compose exec -T backend printenv MONGO_URL)
MONGO_URL=$(docker compose -f $COMPOSE_FILE exec -T backend printenv MONGO_URL)
echo mongo uri: $MONGO_URL
# Dump MongoDB data using credentials
docker compose exec -T $SERVICE_NAME sh -c "mongodump --gzip --archive=/tmp/$DUMP_NAME -d odyssey-test" &&
docker compose -f $COMPOSE_FILE exec -T $SERVICE_NAME sh -c "mongodump --gzip --archive=/tmp/$DUMP_NAME --uri=$MONGO_URL" &&
# Copy the dump from the container to the host
# Note: You will need to know the exact container name for this step
+141
View File
@@ -0,0 +1,141 @@
# Windows Environment Setup
## Install WSL and Ubuntu
Please refer to the Official [Setup WSL](https://learn.microsoft.com/en-us/windows/wsl/setup/environment) on Microsoft's website.
Run the following command in PowerShell as Administrator:
wsl --install
Then restart the computer. After restarting, you can open Ubuntu terminal by searching "Ubuntu" in Start menu. You will be prompted to create a new user account. Once you have done that, you can continue with the following steps.
## Setup Environment (In Ubuntu terminal)
1. Update and upgrade
```
sudo apt-get update
sudo apt-get upgrade
```
1. Install Git
```
sudo apt-get install git
```
1. Install Node.js (Version 20.x)
```
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install nodejs
sudo apt install build-essential
sudo npm install -g yarn
```
## Install Docker
(Refer to [get.docker.com](https://get.docker.com/))
To install the latest stable versions of Docker CLI, Docker Engine, and their
dependencies:
1. Download the script
```
curl -fsSL https://get.docker.com -o install-docker.sh
```
1. verify the script's content
```
cat install-docker.sh
```
1. run the script with --dry-run to verify the steps it executes
```
sh install-docker.sh --dry-run
```
**NOTE: the script will recommend you to use Docker Desktop instead, but we need to use Docker inside WSL for the backend to work.** Just ignore it and wait for the installation to finish.
1. run the script either as root, or using sudo to perform the installation.
```
sudo sh install-docker.sh
```
1. Verify the installation
```
docker --version
```
1. Add your user to the docker group
```
sudo usermod -aG docker $USER
```
**NOTE: You need to create a new WSL terminal to apply the changes.**
1. Verify the installation
```
docker ps
```
This should return something like:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
## Run the Project (In Ubuntu terminal)
1. Clone the repository
```
git clone https://github.com/lancatlin/linux-odyssey.git
cd linux-odyssey
```
Optional: To open the project in VSCode, run the following command inside the project folder:
```
code .
```
1. Install dependencies
```
yarn install
```
It is ok if there are some warnings and `gyp: ERR` errors, just verify there is `done` at the end.
1. Copy the environment variables
```
cp .env.sample .env
```
1. Docker setup
```
docker compose pull
docker compose build
docker compose up -d db
```
<!-- Check folder ./config exist and is empty -->
<!-- Check .env file exist -->
1. Run the project
```
yarn build
yarn dev
```
<!-- Check ./config/ssh_key.pub is a file not a folder -->
Enjoy!
+3 -1
View File
@@ -54,6 +54,8 @@
"typescript": "^5.3.3"
},
"dependencies": {
"latest": "^0.2.0",
"typescript-eslint": "^7.4.0"
}
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
}
+6 -4
View File
@@ -21,14 +21,16 @@ interface Config {
}
const config: Config = {
host: process.env.HOST || 'localhost',
port: process.env.PORT ? parseInt(process.env.PORT, 10) : 3001,
host: process.env.ADMIN_HOST || 'localhost',
port: process.env.ADMIN_PORT ? parseInt(process.env.ADMIN_PORT, 10) : 3001,
db: process.env.MONGO_URL || 'mongodb://localhost:27017/odyssey-test',
username: getOrFailed('ADMIN_USERNAME'),
password: getOrFailed('ADMIN_PASSWORD'),
baseUrl:
process.env.BASE_URL ||
`http://${process.env.HOST || 'localhost'}:${process.env.PORT ? parseInt(process.env.PORT, 10) : 3001}`,
process.env.ADMIN_BASE_URL ||
`http://${process.env.ADMIN_HOST || 'localhost'}:${
process.env.ADMIN_PORT ? parseInt(process.env.ADMIN_PORT, 10) : 3001
}`,
}
export default config
+3 -3
View File
@@ -5,12 +5,12 @@ interface Node {
export default class DAG {
private nodes = new Map()
private edges = new Set()
private edges = new Set<[string, string]>()
private layers: number[] = []
constructor(nodes: Node[]) {
this.nodes = new Map(nodes.map((node) => [node._id, node]))
this.edges = new Set()
this.edges = new Set<[string, string]>()
this.nodes.forEach((_, id) => {
this.setLayer(id)
this.addEdges(id)
@@ -42,7 +42,7 @@ export default class DAG {
if (!node) {
throw new Error(`Node ${id} not found`)
}
return this.layers[node.layer - 1]
return this.layers[node.layer - 1] || 0
}
private setLayer(id: string) {
+121
View File
@@ -0,0 +1,121 @@
# This is the sshd server system-wide configuration file. See
# sshd_config(5) for more information.
# This sshd was compiled with PATH=/usr/local/bin:/usr/bin:/bin:/usr/games
# The strategy used for options in the default sshd_config shipped with
# OpenSSH is to specify options with their default value where
# possible, but leave them commented. Uncommented options override the
# default value.
Include /etc/ssh/sshd_config.d/*.conf
#Port 22
#AddressFamily any
#ListenAddress 0.0.0.0
#ListenAddress ::
#HostKey /etc/ssh/ssh_host_rsa_key
#HostKey /etc/ssh/ssh_host_ecdsa_key
#HostKey /etc/ssh/ssh_host_ed25519_key
# Ciphers and keying
#RekeyLimit default none
# Logging
#SyslogFacility AUTH
#LogLevel INFO
# Authentication:
#LoginGraceTime 2m
#PermitRootLogin prohibit-password
#StrictModes yes
#MaxAuthTries 6
#MaxSessions 10
PubkeyAuthentication yes
# Expect .ssh/authorized_keys2 to be disregarded by default in future.
AuthorizedKeysFile /etc/ssh/authorized_keys/%u
#AuthorizedPrincipalsFile none
#AuthorizedKeysCommand none
#AuthorizedKeysCommandUser nobody
# For this to work you will also need host keys in /etc/ssh/ssh_known_hosts
#HostbasedAuthentication no
# Change to yes if you don't trust ~/.ssh/known_hosts for
# HostbasedAuthentication
#IgnoreUserKnownHosts no
# Don't read the user's ~/.rhosts and ~/.shosts files
#IgnoreRhosts yes
# To disable tunneled clear text passwords, change to no here!
#PasswordAuthentication yes
#PermitEmptyPasswords no
# Change to yes to enable challenge-response passwords (beware issues with
# some PAM modules and threads)
KbdInteractiveAuthentication no
# Kerberos options
#KerberosAuthentication no
#KerberosOrLocalPasswd yes
#KerberosTicketCleanup yes
#KerberosGetAFSToken no
# GSSAPI options
#GSSAPIAuthentication no
#GSSAPICleanupCredentials yes
#GSSAPIStrictAcceptorCheck yes
#GSSAPIKeyExchange no
# Set this to 'yes' to enable PAM authentication, account processing,
# and session processing. If this is enabled, PAM authentication will
# be allowed through the KbdInteractiveAuthentication and
# PasswordAuthentication. Depending on your PAM configuration,
# PAM authentication via KbdInteractiveAuthentication may bypass
# the setting of "PermitRootLogin prohibit-password".
# If you just want the PAM account and session checks to run without
# PAM authentication, then enable this but set PasswordAuthentication
# and KbdInteractiveAuthentication to 'no'.
UsePAM yes
#AllowAgentForwarding yes
#AllowTcpForwarding yes
#GatewayPorts no
X11Forwarding no
#X11DisplayOffset 10
#X11UseLocalhost yes
#PermitTTY yes
#PrintMotd yes
#PrintLastLog yes
#TCPKeepAlive yes
#PermitUserEnvironment no
#Compression delayed
#ClientAliveInterval 0
#ClientAliveCountMax 3
#UseDNS no
#PidFile /run/sshd.pid
#MaxStartups 10:30:100
#PermitTunnel no
#ChrootDirectory none
#VersionAddendum none
# no default banner path
#Banner none
# Allow client to pass locale environment variables
AcceptEnv LANG LC_* NODE_PATH ZDOTDIR API_ENDPOINT TOKEN
# override default of no subsystems
Subsystem sftp /usr/lib/openssh/sftp-server
# Example of overriding settings on a per-user basis
#Match User anoncvs
# X11Forwarding no
# AllowTcpForwarding no
# PermitTTY no
# ForceCommand cvs server
+18 -12
View File
@@ -1,26 +1,32 @@
FROM alpine:3.18
FROM debian:bookworm-slim
LABEL maintainer="wancat@wancat.cc"
RUN apk add --no-cache \
RUN apt-get update && apt-get install -y \
vim \
zsh \
nodejs \
yarn
curl \
openssh-server
RUN curl -fsSL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
RUN bash nodesource_setup.sh
RUN apt-get install -y nodejs
RUN npm install -g yarn
RUN node -v && yarn -v
WORKDIR /usr/local/lib/container
COPY ./packages/container/package.json ./yarn.lock ./
RUN yarn install --modules-folder /usr/src/node_modules
ENV NODE_PATH=/usr/src/node_modules
COPY ./packages/container /usr/local/lib/container
COPY ./quests/.includes/zshrc /etc/zsh/zshrc
RUN rm -f /etc/motd /etc/issue /etc/issue.net /etc/update-motd.d/*
RUN rm -rf /etc/skel && mkdir -p /etc/skel
RUN mkdir -p /etc/ssh/authorized_keys && chmod 755 /etc/ssh/authorized_keys
COPY ./quests/.includes/sshd_config /etc/ssh/sshd_config
COPY ./quests/entrypoint.sh /entrypoint.sh
ENV USERNAME=commander
EXPOSE 22
RUN adduser --disabled-password --gecos '' --shell /bin/zsh ${USERNAME}
USER ${USERNAME}
WORKDIR /home/${USERNAME}
CMD [ "/bin/zsh" ]
ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]
+12 -22
View File
@@ -1,25 +1,23 @@
title: 輸出文字
instruction: |
在這個關卡中,你將會學到:
1. 如何使用 `echo` 指令
準備好就輸入 `echo start` 開始吧!
1. 如何使用 `echo` 在終端機上顯示文字。
requirements:
- get-started
stages:
- id: start
task: 輸入 `echo start` 來開始教程
task: 按下 `開始` 按鈕開始
condition:
output:
- ^start$
command:
- ^echo start$
responses:
- content:
- 你剛才使用的指令叫做 `echo`。
- '`echo` 指令可以將後方接續的文字輸出到終端機上。'
- 例如你輸入 `echo Hello`,終端機就會顯示 `Hello`。
- 你可以試著輸入 `echo` 並在後面加上一些文字,然後按下 Enter 鍵,就可以看到終端機上顯示了你剛才輸入的文字。
- content: |
還記得第一關使用的指令 `echo` 嗎?
`echo` 指令可以將後方接續的文字輸出到終端機上。
例如你輸入 `echo Hello`,終端機就會顯示 `Hello`。
你可以試著輸入 `echo ` 並在後面加上一些文字,然後按下 Enter 鍵,就可以看到終端機上顯示了你剛才輸入的文字。
hints:
- ➤ 輸入 `echo` 並在後面加上一些文字
- ➤ 例如:`echo example`
@@ -43,8 +41,8 @@ stages:
requirements:
- echo
condition:
output:
- ^[Hh]ow are you\??$
command:
- ^echo [Hh]ow are you\??$
exceptions:
- condition:
command:
@@ -59,17 +57,9 @@ stages:
responses:
- type: narrative
content:
- 在 `echo` 後面還需要加上一些文字
- 在 `echo ` 後面還需要加上 `How are you?`
responses:
- content:
- 你成功的在終端機上顯示了 `How are you?`。
- 相信你已經了解如何使用 `echo` 指令來顯示文字了。
- 之後如果要在終端機顯示文字,記得可以使用 `echo` 指令。
exceptions:
- repeatable: true
condition:
command:
- ' '
hints:
- '!! 請勿使用全形空格 !!'
-131
View File
@@ -1,131 +0,0 @@
title: 輸出文字
instruction: |
在這個關卡中,你將會學到:
1. 如何使用 `echo` 指令
2. `echo` 指令在遊戲中的用途
準備好就輸入 `echo start` 開始吧!
requirements:
- get-started
stages:
- id: warning-01
repeatable: true
condition:
command:
- ' '
hints:
- '!! 請勿使用全形空格 !!'
- id: start
task: 輸入 `echo start` 來開始教程
condition:
output:
- ^start$
responses:
- content:
- 你剛才使用的指令叫做 `echo`。
- '`echo` 指令可以將後方接續的文字輸出到終端機上。'
- 例如你輸入 `echo Hello`,終端機就會顯示 `Hello`。
- 你可以試著輸入 `echo` 並在後面加上一些文字,然後按下 Enter 鍵,就可以看到終端機上顯示了你剛才輸入的文字。
hints:
- ➤ 輸入 `echo` 並在後面加上一些文字
- ➤ 例如:`echo example`
- id: echo
task: 在終端機上顯示顯示任意文字
requirements:
- start
condition:
command:
- ^echo .*
responses:
- content:
- 你應該可以看到終端機上顯示了你在 `echo` 指令後面的文字。
- 接下來,請你試著在終端機上顯示 `How are you?`。
hints:
- ➤ 利用 `echo` 指令來在終端機上顯示 `How are you?`
- id: how-are-you
task: 在終端機上顯示 `How are you?`
requirements:
- echo
condition:
output:
- ^[Hh]ow are you\??$
exceptions:
- condition:
command:
- ^[Hh]ow are you\??$
responses:
- type: narrative
content:
- 在 `How are you?` 前面必須加上 `echo`
- condition:
command:
- ^echo$
responses:
- type: narrative
content:
- 在 `echo` 後面還需要加上一些文字
responses:
- content:
- 你成功的在終端機上顯示了 `How are you?`。
- 相信你已經了解 `echo` 指令的用法了。
- 接下來,要像你介紹 `echo` 在遊戲中的特殊功能,那就是詠唱咒語。
- 你可以通過輸入 `echo [咒語]` 來詠唱咒語,並產生對應的特殊效果。
- 但是要注意,詠唱咒語只有在 Linux Odyssey 中才會有特殊效果。
- 在真實的 Linux 環境中,詠唱咒語並不會有任何特殊效果。
- 現在,有一段咒語叫做 `HELP`,請你試著使用 `echo` 詠唱這段咒語。
hints:
- ➤ 試著使用 `echo` 來詠唱 `HELP` 咒語
- ➤ 注意:咒語要使用大寫
- id: help
task: 詠唱 `HELP` 咒語
requirements:
- how-are-you
condition:
output:
- ^HELP$
responses:
- content:
- 你詠唱了 `HELP` 咒語,一位精靈出現了。
- type: dialogue
speaker: Unix 精靈
content:
- 你好,我是 Unix 精靈。
- 既然你使用了 `HELP` 咒語呼喚我,就讓我來教你一個咒語吧。
- 讓我想想... 好了,我想到了一個咒語,叫做 `WATER`。
- 這是施展水魔法的咒語。詠唱這個咒語可以施展水魔法,產生少量的水。
- 試著使用 `echo` 詠唱這個咒語吧。
hints:
- ➤ 詠唱 `WATER` 咒語
- id: END
task: 詠唱 `WATER` 咒語
requirements:
- help
condition:
output:
- ^WATER$
responses:
- content:
- 你施展了水魔法,一個水球出現在你的手中。
- type: dialogue
speaker: Unix 精靈
content:
- 很好,你已經學會了水魔法。
- content:
- 真厲害,你已經了解如何使用 `echo` 指令,並且學會了詠唱咒語的方法。
- 最後複習一下,你可以通過輸入 `echo [文字]` 來在終端機上顯示文字。
- 你也可以通過輸入 `echo [咒語]` 來詠唱咒語,並產生對應的特殊效果。
- 不要忘了,詠唱咒語只有在 Linux Odyssey 中才會有特殊效果。
- 在真實的 Linux 環境中,咒語只會被視為一串文字顯示出來而已。
- 以上就是 `echo` 指令的用法,請繼續努力,完成接下來的關卡吧!
hints: |
複習:
通過輸入 `echo [文字]` 來在終端機上顯示文字
通過輸入 `echo [咒語]` 來詠唱咒語
咒語只有在 Linux Odyssey 中才會有特殊效果
+7
View File
@@ -0,0 +1,7 @@
echo start
echo next
ls
cd folder03
pwd
cd ../folder02
ls ../folder01
+110
View File
@@ -0,0 +1,110 @@
title: 測驗一
instruction: |
在這個關卡中,將會考驗你是否理解以下內容:
1. `echo`:用來輸出文字
2. `ls`:用來查看資料夾的內容
3. `cd`:用來在資料夾之間移動
4. `pwd`:用來顯示目前的路徑
requirements:
- path
stages:
- id: start
task: 按下 `開始` 按鈕開始
condition:
command:
- ^echo start$
responses:
- type: narrative
content: |
這個關卡將會測試你是否理解之前的教學內容。
因此不會告訴你要輸入什麼指令。
請思考並應用正確的指令來完成任務。
現在,請讓終端機輸出 `next` 來繼續。
- id: next
task: 讓終端機輸出 `next`
requirements:
- start
condition:
output:
- ^next$
responses:
- type: narrative
content: |
現在請你查看目前資料夾的內容。
- id: ls-~
task: 查看目前資料夾的內容
requirements:
- next
condition:
pwd:
- ^/home/commander$
command:
- ^ls$
responses:
- type: narrative
content: |
請進入 `folder03` 資料夾。
- id: cd-folder03
task: 進入 `folder03` 資料夾
requirements:
- ls-~
condition:
pwd:
- ^/home/commander/folder03$
responses:
- type: narrative
content: |
請在終端機顯示目前的路徑。
- id: pwd-folder03
task: 顯示目前的路徑
requirements:
- cd-folder03
condition:
command:
- ^pwd$
output:
- ^/home/commander/folder03$
responses:
- type: narrative
content: |
現在請你進入 `folder02` 資料夾,
並查看 `folder02` 資料夾的內容。
- id: ls-folder02
task: 進入並查看 `folder02` 資料夾的內容
requirements:
- pwd-folder03
condition:
pwd:
- ^/home/commander/folder02$
command:
- ^ls$
responses:
- type: narrative
content: |
最後,請你留在 `folder02` 資料夾,
並查看 `folder01` 資料夾的內容。
- id: END
requirements:
- ls-folder02
task: 留在 `folder02` 資料夾,查看 `folder01` 資料夾的內容。
condition:
pwd:
- ^/home/commander/folder02$
command:
- ^ls
output:
- file1.txt
responses:
- type: narrative
content: |
恭喜你通過了這個測驗!
你可以繼續學習之後的教學內容了。
Whitespace-only changes.
Whitespace-only changes.
Whitespace-only changes.
+7
View File
@@ -0,0 +1,7 @@
echo start
echo next
ls
cat hello.txt
cat pneumonoultramicroscopicsilicovolcanoconiosis.txt
mkdir folder
touch folder/file.txt
+108
View File
@@ -0,0 +1,108 @@
title: 測驗二
instruction: |
在這個關卡中,將會考驗你是否理解以下內容:
1. `cat`:用來查看檔案的內容
2. `touch`:用來建立檔案
3. `mkdir`:用來建立資料夾
4. 用 `tab` 鍵來自動補全
5. 之前測驗包含的內容
requirements:
- create
stages:
- id: start
task: 按下 `開始` 按鈕開始
condition:
command:
- ^echo start$
responses:
- type: narrative
content: |
這個關卡將會測試你是否理解之前的教學內容。
因此不會告訴你要輸入什麼指令。
請思考並應用正確的指令來完成任務。
現在,請讓終端機輸出 `next` 來繼續。
- id: next
task: 讓終端機輸出 `next`
requirements:
- start
condition:
output:
- ^next$
responses:
- type: narrative
content: |
現在請你查看目前資料夾的內容。
- id: ls-~
task: 查看目前資料夾的內容
requirements:
- next
condition:
pwd:
- ^/home/commander$
command:
- ^ls$
responses:
- type: narrative
content: |
請查看 `hello.txt` 檔案的內容。
- id: cat-hello
task: 查看 `hello.txt` 檔案內容
requirements:
- ls-~
condition:
command:
- ^cat hello.txt$
output:
- ^This is `hello.txt`.$
responses:
- type: narrative
content: |
請查看另一個有著很長檔名的檔案內容。
- id: cat-long-filename
task: 查看另一個檔案的內容
requirements:
- cat-hello
condition:
command:
- ^cat pneumonoultramicroscopicsilicovolcanoconiosis.txt$
output:
- ^A name that has been invented for a lung disease caused by breathing in very small pieces of ash or dust.$
responses:
- type: narrative
content: |
現在請你建立一個名稱為 `folder` 的資料夾。
- id: mkdir-folder
task: 建立名稱為 `folder` 的資料夾
requirements:
- cat-long-filename
condition:
files:
- path: /home/commander/folder
type: folder
responses:
- type: narrative
content: |
最後,請你在 `folder` 資料夾中,
建立檔名為 `file.txt` 的檔案。
- id: END
requirements:
- mkdir-folder
task: 在 `folder` 中建立檔名為 `file.txt` 的檔案
condition:
files:
- path: /home/commander/folder/file.txt
type: file
responses:
- type: narrative
content: |
恭喜你通過了這個測驗!
你可以繼續學習之後的教學內容了。
+1
View File
@@ -0,0 +1 @@
This is `hello.txt`.
@@ -0,0 +1 @@
A name that has been invented for a lung disease caused by breathing in very small pieces of ash or dust.
+12
View File
@@ -0,0 +1,12 @@
echo start
echo next
ls
cd folder
cp hello.txt world.txt
rm hello.txt
mv world.txt ..
cd ..
mv world.txt hello.txt
cat hello.txt
rmdir folder
rm -r trash_can
+153
View File
@@ -0,0 +1,153 @@
title: 測驗三
instruction: |
在這個關卡中,將會考驗你是否理解以下內容:
1. `cp`:用來複製檔案和資料夾
2. `mv`:用來移動檔案和資料夾或更改名稱
3. `rm`:用來刪除檔案和資料夾
4. `rmdir`:用來刪除空的資料夾
5. 透過選項讓指令達成不同的功能,例如 `rm -r`
6. 之前測驗包含的內容
requirements:
- remove
stages:
- id: start
task: 按下 `開始` 按鈕開始
condition:
command:
- ^echo start$
responses:
- type: narrative
content: |
這個關卡將會測試你是否理解之前的教學內容。
因此不會告訴你要輸入什麼指令。
請思考並應用正確的指令來完成任務。
現在,請讓終端機輸出 `next` 來繼續。
- id: next
task: 讓終端機輸出 `next`
requirements:
- start
condition:
output:
- ^next$
responses:
- type: narrative
content: |
現在請你查看目前資料夾的內容。
- id: ls-~
task: 查看目前資料夾的內容
requirements:
- next
condition:
pwd:
- ^/home/commander$
command:
- ^ls$
responses:
- type: narrative
content: |
請複製 `folder` 資料夾中的檔案到 `folder` 中,並命名為 `world.txt` 。
- id: cp-hello-world
task: 複製 `folder` 中的檔案並命名為 `world.txt`
requirements:
- ls-~
condition:
command:
- ^cp .*hello.txt .*world.txt$
files:
- path: /home/commander/folder/hello.txt
type: file
- path: /home/commander/folder/world.txt
type: file
responses:
- type: narrative
content: |
請刪除 `hello.txt` 檔案。
- id: rm-hello
task: 刪除 `hello.txt`
requirements:
- cp-hello-world
condition:
command:
- ^rm .*hello.txt$
files:
- path: /home/commander/folder/hello.txt
type: file
exists: false
responses:
- type: narrative
content: |
現在請將 `world.txt` 移出 `folder` 資料夾。
(移到 `commander` 資料夾中)
- id: mv-world-..
task: 將 `world.txt` 移出 `folder` 資料夾
requirements:
- rm-hello
condition:
files:
- path: /home/commander/folder/world.txt
type: file
exists: false
- path: /home/commander/world.txt
type: file
responses:
- type: narrative
content: |
將 `world.txt` 的名稱改回 `hello.txt` ,
並查看檔案的內容。
- id: cat-hello
task: 將 `world.txt` 的名稱改回 `hello.txt` 後查看檔案內容
requirements:
- mv-world-..
condition:
command:
- ^cat hello.txt$
files:
- path: /home/commander/world.txt
type: file
exists: false
- path: /home/commander/hello.txt
type: file
output:
- ^This is `hello.txt`.$
responses:
- type: narrative
content: |
刪除 `folder` 資料夾。
- id: rmdir-folder
task: 刪除 `folder` 資料夾
requirements:
- cat-hello
condition:
files:
- path: /home/commander/folder
type: folder
exists: false
responses:
- type: narrative
content: |
刪除 `trash_can` 資料夾。
- id: END
requirements:
- rmdir-folder
task: 刪除 `trash_can` 資料夾
condition:
files:
- path: /home/commander/trash_can
type: folder
exists: false
responses:
- type: narrative
content: |
恭喜你通過了這個測驗!
你可以繼續學習之後的教學內容了。
@@ -0,0 +1 @@
This is `hello.txt`.
Whitespace-only changes.
Whitespace-only changes.
@@ -0,0 +1 @@
aHR0cHM6Ly9yZXVybC5jYy9YUjZZMDA=
Whitespace-only changes.
-3
View File
@@ -1,3 +0,0 @@
FROM linuxodyssey/quest-base
COPY home ${HOME}
+2 -1
View File
@@ -1,7 +1,8 @@
echo start
ls
cat hello.txt
cat world.txt
echo continue
echo next
cp hello.txt hello2.txt
cat hello2.txt
cp world.txt world2.txt
+240 -93
View File
@@ -1,122 +1,186 @@
title: 複製檔案
instruction: |
在這個關卡中,你將會學到:
1. 如何用 `cp` 指令複製檔案
準備好就輸入 `echo start` 開始吧!
1. 如何使用 `cp` 複製檔案
requirements:
- create
stages:
- id: start
task: 輸入 `echo start` 來開始
task: 按下 `開始` 按鈕開始
condition:
output:
- start
exceptions:
- condition:
command:
- ^echo$
responses:
- type: narrative
content:
- 你忘記輸入 `start` 了嗎?
- 請輸入 `echo start` 來開始
- catchAll: true
responses:
- type: narrative
content:
- 請輸入 `echo start` 來開始
command:
- ^echo start$
responses:
- type: narrative
content:
- 今天我們要學習如何複製檔案。
- 現在資料夾裡有一個 `hello.txt` 跟一個 `world.txt`,請使用 `ls` 與 `cat` 來查看它們的內容。
- 看完之後,使用 `echo continue` 來繼續吧!
content: |
今天我們要學習如何複製檔案。
先用 `ls` 指令查看目前資料夾裡有哪些檔案。
hints:
- ➤ 使用 `ls` 來查看目前資料夾裡有哪些檔案
- id: ls
task: 查看目前資料夾裡的檔案
requirements:
- start
condition:
pwd:
- ^/home/commander$
command:
- ^ls$
output:
- (^|\s)hello.txt($|\s)
- (^|\s)world.txt($|\s)
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content: |
可以看到現在資料夾裡有 `hello.txt` 跟 `world.txt`。
請使用 `cat` 來查看它們的內容。
看完之後,使用 `echo next` 來繼續吧!
hints:
- ➤ 使用 `ls` 來查看資料夾內的檔案
- ➤ 使用 `cat hello.txt` 以及 `cat world.txt` 來查看檔案內容
- ➤ 如果終端機卡在某個指令無法輸入,請按下 `Ctrl + C` 來取消該指令
- id: cat-hello
task: 查看 `hello.txt` 的內容
requirements:
- start
- ls
condition:
pwd:
- ^/home/commander$
command:
- ^cat hello.txt$
output:
- Hello
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾
- condition:
command:
- ^cat$
responses:
- type: narrative
content:
- 你忘記輸入 `cat` 了嗎?
- 請輸入 `cat hello.txt` 來查看 `hello.txt` 的內容
content: |
你忘記輸入 `cat` 了嗎?
請輸入 `cat hello.txt` 來查看 `hello.txt` 的內容
- condition:
command:
- ^cat hello$
responses:
- type: narrative
content:
- 你忘記輸入 `.txt` 了嗎?
- 請輸入 `cat hello.txt` 來查看 `hello.txt` 的內容
content: |
你忘記輸入 `.txt` 了嗎?
請輸入 `cat hello.txt` 來查看 `hello.txt` 的內容
responses:
- type: narrative
content:
- 你成功查看到 `hello.txt` 的內容了!
content: |
你成功查看到 `hello.txt` 的內容了!
- id: cat-world
task: 查看 `world.txt` 的內容
requirements:
- start
- ls
condition:
pwd:
- ^/home/commander$
command:
- ^cat world.txt$
output:
- World
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾
- condition:
command:
- ^cat$
responses:
- type: narrative
content: |
你忘記輸入 `cat` 了嗎?
請輸入 `cat world.txt` 來查看 `world.txt` 的內容
- condition:
command:
- ^cat world$
responses:
- type: narrative
content: |
你忘記輸入 `.txt` 了嗎?
請輸入 `cat world.txt` 來查看 `world.txt` 的內容
responses:
- type: narrative
content:
- 你成功查看到 `world.txt` 的內容了!
content: |
你成功查看到 `world.txt` 的內容了!
- id: cat-continue
task: 使用 `echo continue` 來繼續
- id: cat-next
task: 輸入 `echo next` 來繼續
requirements:
- cat-hello
- cat-world
condition:
command:
- echo
- ^echo next$
responses:
- type: narrative
content:
- 接下來我們要來學習複製檔案。
- '`cp` 這個指令,是 copy 的縮寫,就是複製的意思。'
- 我們可以用 `cp [來源檔案] [目的檔案]` 的方式來複製檔案。
- 請你使用 `cp` 來複製 `hello.txt` 到 `hello2.txt`。
content: |
接下來我們要來學習如何複製檔案。
`cp` 這個指令,是 copy 的縮寫,就是複製的意思。
我們可以用 `cp [來源檔案] [目的檔案]` 的方式來複製檔案。
請你使用 `cp` 來複製 `hello.txt` 的內容到 `hello2.txt`。
hints:
- ➤ 使用 `cp hello.txt hello2.txt` 來複製 `hello.txt` 到 `hello2.txt`
- id: cp-hello
task: 複製 `hello.txt` 到 `hello2.txt`
requirements:
- cat-continue
- cat-next
condition:
pwd:
- ^/home/commander$
command:
- ^cp hello.txt hello2.txt$
files:
- path: hello2.txt
- path: /home/commander/hello2.txt
type: file
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功複製 `hello.txt` 到 `hello2.txt` 了!
- 我們打開來確認一下 `hello2.txt` 的內容吧!
content: |
你成功複製 `hello.txt` 到 `hello2.txt` 了!
我們打開來確認一下 `hello2.txt` 的內容吧!
hints:
- ➤ 使用 `cat hello2.txt` 來查看 `hello2.txt` 的內容
@@ -125,16 +189,28 @@ stages:
- cp-hello
task: 查看 `hello2.txt` 的內容
condition:
pwd:
- ^/home/commander$
command:
- ^cat hello2.txt$
output:
- Hello
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功查看到 `hello2.txt` 的內容了!
- 正如我們所見,`hello2.txt` 的內容跟 `hello.txt` 一模一樣。
- 那我們再來試試看複製 `world.txt` 到 `world2.txt` 吧!
content: |
你成功查看到 `hello2.txt` 的內容了!
正如我們所見,`hello2.txt` 的內容跟 `hello.txt` 一模一樣。
那我們再來試試看複製 `world.txt` 到 `world2.txt` 吧!
hints:
- ➤ 使用 `cp world.txt world2.txt` 來複製 `world.txt` 到 `world2.txt`
@@ -143,16 +219,28 @@ stages:
- cat-hello2
task: 複製 `world.txt` 到 `world2.txt`
condition:
pwd:
- ^/home/commander$
command:
- ^cp world.txt world2.txt$
files:
- path: world2.txt
- path: /home/commander/world2.txt
type: file
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功複製 `world.txt` 到 `world2.txt` 了!
- 我們打開來確認一下 `world2.txt` 的內容吧!
content: |
你成功複製 `world.txt` 到 `world2.txt` 了!
我們打開來確認一下 `world2.txt` 的內容吧!
hints:
- ➤ 使用 `cat world2.txt` 來查看 `world2.txt` 的內容
@@ -161,23 +249,35 @@ stages:
- cp-world
task: 查看 `world2.txt` 的內容
condition:
pwd:
- ^/home/commander$
command:
- ^cat world2.txt$
output:
- World
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功查看到 `world2.txt` 的內容了!
- '`world2.txt` 的內容跟 `world.txt` 一模一樣。'
- 接下來我們要來學習如何複製資料夾。
- 現在目錄下有一個 `notes` 資料夾,裡面有一個 `note.txt` 的檔案。
- 我們要能整個資料夾包含裡面的檔案一起複製到 `notes2`。
- 跟複製單一檔案不一樣的是,複製資料夾時,我們要加上 `-r` 的選項(recursive)代表將資料夾中的所有檔案都一起複製。
- 在使用指令時,如果想要調整指令的行為,可以在指令後面加上選項。
- 選項的格式通常是 `-` 加上一個字母,例如 `-r`。
- 選項擺放的位置沒有特別的限制,通常會跟在指令的後面,置於檔案名稱的前面。
- 請你使用 `cp -r notes notes2` 來複製 `notes` 資料夾到 `notes2`。
content: |
你成功查看到 `world2.txt` 的內容了!
`world2.txt` 的內容跟 `world.txt` 一模一樣。
接下來我們要來學習如何複製資料夾。
現在目錄下有一個 `notes` 資料夾,裡面有一個 `note.txt` 的檔案。
我們要能整個資料夾包含裡面的檔案一起複製到 `notes2`。
跟複製單一檔案不一樣的是,複製資料夾時,我們要加上 `-r` 的選項(recursive)代表將資料夾中的所有檔案都一起複製。
在使用指令時,如果想要調整指令的行為,可以在指令後面加上選項。
選項的格式通常是 `-` 加上一個字母,例如 `-r`。
選項擺放的位置沒有特別的限制,通常會跟在指令的後面,置於檔案名稱的前面。
請你使用 `cp -r notes notes2` 來複製 `notes` 資料夾到 `notes2`。
hints:
- ➤ 使用 `cp -r notes notes2` 來複製 `notes` 資料夾到 `notes2`
- ➤ 記得要加上 `-r` 的選項來複製所有檔案
@@ -187,45 +287,68 @@ stages:
- cat-world2
task: 複製 `notes` 資料夾到 `notes2`
condition:
pwd:
- ^/home/commander$
command:
- ^cp
files:
- path: notes2
- path: /home/commander/notes2
type: directory
- path: notes2/note.txt
- path: /home/commander/notes2/note.txt
type: file
responses:
- type: narrative
content:
- 你成功複製 `notes` 資料夾到 `notes2` 了!
- 我們打開來確認一下 `notes2` 資料夾的內容吧!
hints:
- ➤ 使用 `ls notes2` 來查看 `notes2` 資料夾的內容
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
- condition:
error:
- 'cp: omitting directory'
responses:
- type: narrative
content:
- 你忘記加上 `-r` 的參數了嗎?
- 請輸入 `cp -r notes notes2` 來複製 `notes` 資料夾到 `notes2`
content: |
你忘記加上 `-r` 的參數了嗎?
請輸入 `cp -r notes notes2` 來複製 `notes` 資料夾到 `notes2`
responses:
- type: narrative
content: |
你成功複製 `notes` 資料夾到 `notes2` 了!
我們打開來確認一下 `notes2` 資料夾的內容吧!
hints:
- ➤ 使用 `ls notes2` 來查看 `notes2` 資料夾的內容
- id: ls-notes2
requirements:
- cp-notes
task: 查看 `notes2` 資料夾的內容
condition:
pwd:
- ^/home/commander$
command:
- ^ls notes2$
output:
- note.txt
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功查看到 `notes2` 資料夾的內容了!
- 我們可以看到,整個 `notes` 資料夾包含裡面的檔案,都被複製到 `notes2` 資料夾了。
- 那麼最後我們要來試試看,如果複製一個檔案到已經存在的檔案會發生什麼事。
content: |
你成功查看到 `notes2` 資料夾的內容了!
我們可以看到,整個 `notes` 資料夾包含裡面的檔案,都被複製到 `notes2` 資料夾了。
那麼最後我們要來試試看,如果複製一個檔案到已經存在的檔案會發生什麼事。
hints:
- ➤ 使用 `cp hello.txt world.txt` 來複製 `hello.txt` 到 `world.txt`
@@ -234,13 +357,25 @@ stages:
- ls-notes2
task: 複製 `hello.txt` 到 `world.txt`
condition:
pwd:
- ^/home/commander$
command:
- ^cp hello.txt world.txt$
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功複製 `hello.txt` 到 `world.txt` 了!
- 我們打開來確認一下 `world.txt` 的內容吧!
content: |
你成功複製 `hello.txt` 到 `world.txt` 了!
我們打開來確認一下 `world.txt` 的內容吧!
hints:
- ➤ 使用 `cat world.txt`
@@ -249,14 +384,26 @@ stages:
- cp-overwrite
task: 檢查 `world.txt` 的內容
condition:
pwd:
- ^/home/commander$
command:
- ^cat world.txt$
output:
- Hello
exceptions:
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content: |
你不在 `/home/commander` 資料夾裡。
請使用 `cd /home/commander` 來返回 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- '`world.txt` 的內容變成 `Hello` 了!'
- 這是因為,當我們複製檔案時,如果目的檔案已經存在,那麼目的檔案的內容就會被覆蓋掉。
- 所以在複製檔案的時候,要特別注意目的檔案是否已經存在,否則可能會不小心把資料弄丟。
- 以上就是複製檔案的基本操作!
content: |
`world.txt` 的內容變成 `Hello` 了!
這是因為,當我們複製檔案時,如果目的檔案已經存在,那麼目的檔案的內容就會被覆蓋掉。
所以在複製檔案的時候,要特別注意目的檔案是否已經存在,否則可能會不小心把資料弄丟。
以上就是複製檔案的基本操作!
+1
View File
@@ -1,4 +1,5 @@
echo start
ls
touch hello.txt
ls
cat hello.txt
+93 -57
View File
@@ -4,40 +4,64 @@ instruction: |
1. 如何使用 `touch` 建立檔案
2. 如何使用 `mkdir` 建立資料夾
準備好就輸入 `echo start` 開始吧!
requirements:
- read
- tab
stages:
- id: start
task: 輸入 `echo start` 來開始
task: 按下 `開始` 按鈕開始
condition:
command:
- ^echo start
- ^echo start$
responses:
- type: narrative
content:
- 這次要學習的指令是 `touch` 指令。
- '`touch` 指令可以建立一個檔案。'
- 接下來,請你試著在終端機上建立一個檔案,檔名為 `hello.txt`。
content: |
這次要學習的指令是 `touch` 指令。
請你先用 `ls` 指令查看目前所在資料夾中有哪些檔案。
你應該會發現目前所在資料夾中沒有任何檔案。
hints:
- ➤ 輸入 `ls` 指令來查看目前所在資料夾中有哪些檔案
- id: ls
task: 查看資料夾中的檔案
requirements:
- start
condition:
command:
- ^ls$
responses:
- type: narrative
content: |
你應該可以看到終端機上沒有任何回應,這表示目前所在資料夾中沒有任何檔案。
而我們可以使用 `touch [檔案名稱]` 指令來建立一個檔案。
接下來,請你試著在終端機上建立一個檔案,檔名為 `hello.txt`。
hints:
- ➤ 輸入 `touch hello.txt` 來建立一個檔案
- id: touch
task: 使用 `touch` 指令來建立一個檔案
requirements:
- start
- ls
condition:
files:
- path: hello.txt
- path: /home/commander/hello.txt
type: file
exceptions:
- condition:
files:
- path: /home/commander/hello
type: file
responses:
- type: narrative
content: |
你似乎忘記輸入副檔名 `txt` 了。
請再試一次,並確保檔名為 `hello.txt`。
responses:
- type: narrative
content:
- 你應該可以看到終端機上沒有任何回應。
- 這表示 `touch` 指令已經成功建立了一個檔案。
- 接下來,請你用之前學過的 `ls` 指令來查看目前所在資料夾中有哪些檔案。
content: |
你應該可以看到終端機上沒有任何回應。
然而實際上 `touch` 指令已經成功建立了一個檔案。
請你用之前學過的 `ls` 指令來查看目前所在資料夾中有哪些檔案。
hints:
- ➤ 輸入 `ls` 指令來查看目前所在資料夾中有哪些檔案
@@ -52,26 +76,28 @@ stages:
- hello.txt
responses:
- type: narrative
content:
- 你應該可以看到終端機上顯示了 `hello.txt` 這個檔案。
- 我們來看看 `hello.txt` 檔案的內容吧!
- 我們可以使用之前學過的 `cat` 指令來查看檔案內容。
content: |
你應該可以看到終端機上顯示了 `hello.txt` 這個檔案。
我們來看看 `hello.txt` 檔案的內容吧!
我們可以使用之前學過的 `cat` 指令來查看檔案內容。
hints:
- ➤ 輸入 `cat hello.txt` 來查看 `hello.txt` 檔案的內容
- id: cat
task: 使用 `cat` 指令來查看 `hello.txt` 檔案的內容
requirements:
- ls-touch
condition:
command:
- ^cat hello.txt$
responses:
- type: narrative
content:
- 咦?竟然什麼都沒有!
- 沒錯,使用 `touch` 指令建立的檔案是空的。
- 我們在未來會學習如何編輯檔案的內容。
- 再來試試建立其他的檔案吧!
- 請你試著在終端機上建立另一個檔案,檔名為 `world.txt`。
content: |
咦?竟然什麼都沒有!
沒錯,使用 `touch` 指令建立的檔案是空的。
我們在未來會學習如何編輯檔案的內容。
再來試試建立其他的檔案吧!
請你試著在終端機上建立另一個檔案,檔名為 `world.txt`。
hints:
- ➤ 輸入 `touch world.txt` 來建立一個檔案
@@ -81,13 +107,23 @@ stages:
- ls-touch
condition:
files:
- path: world.txt
- path: /home/commander/world.txt
type: file
exceptions:
- condition:
files:
- path: /home/commander/world
type: file
responses:
- type: narrative
content: |
你似乎忘記輸入副檔名 `txt` 了。
請再試一次,並確保檔名為 `world.txt`。
responses:
- type: narrative
content:
- 非常好,你已經成功建立了第二個檔案。
- 接下來,請你用之前學過的 `ls` 指令來查看剛剛建立的兩個檔案。
content: |
非常好,你已經成功建立了第二個檔案。
接下來,請你用之前學過的 `ls` 指令來查看剛剛建立的兩個檔案。
hints:
- ➤ 輸入 `ls` 指令來查看目前所在資料夾中有哪些檔案
@@ -99,16 +135,16 @@ stages:
command:
- ^ls$
output:
- hello.txt
- world.txt
- (^|\s)hello.txt($|\s)
- (^|\s)world.txt($|\s)
responses:
- type: narrative
content:
- 你應該可以看到終端機上顯示了 `hello.txt` 和 `world.txt` 這兩個檔案。
- 接下來,我們來試試看建立資料夾吧!
- '`mkdir` 指令可以建立一個空的資料夾。'
- 使用方式是 `mkdir [資料夾名稱]`。
- 請你試著在終端機上建立一個資料夾,名稱為 `notes`。
content: |
你應該可以看到終端機上顯示了 `hello.txt` 和 `world.txt` 這兩個檔案。
接下來,我們來試試看建立資料夾吧!
`mkdir` 指令可以建立一個空的資料夾。
使用方式是 `mkdir [資料夾名稱]`。
請你試著在終端機上建立一個資料夾,名稱為 `notes`。
hints:
- ➤ 輸入 `mkdir notes` 來建立一個資料夾
@@ -118,13 +154,13 @@ stages:
- ls-2
condition:
files:
- path: notes
- path: /home/commander/notes
type: folder
responses:
- type: narrative
content:
- 非常好,你已經成功建立了 `notes` 資料夾。
- 接下來,請你用 `ls` 指令來查看剛剛建立的資料夾。
content: |
非常好,你已經成功建立了 `notes` 資料夾。
接下來,請你用 `ls` 指令來查看剛剛建立的資料夾。
- id: ls-mkdir
task: 使用 `ls` 查看剛建立的資料夾
@@ -137,11 +173,11 @@ stages:
- notes
responses:
- type: narrative
content:
- 你應該可以看到終端機上顯示了 `notes` 這個資料夾。
- 接下來,我們要在 `notes` 資料夾中建立一個 `note.txt` 的檔案。
- 首先,我們要先進入 `notes` 資料夾。
- 還記得之前的 `cd` 指令嗎?請你試著使用 `cd` 指令來進入 `notes` 資料夾。
content: |
你應該可以看到終端機上顯示了 `notes` 這個資料夾。
接下來,我們要在 `notes` 資料夾中建立一個 `note.txt` 的檔案。
首先,我們要先進入 `notes` 資料夾。
還記得之前的 `cd` 指令嗎?請你試著使用 `cd` 指令來進入 `notes` 資料夾。
hints:
- ➤ 輸入 `cd notes` 來進入 `notes` 資料夾
- ➤ 可以在輸入到 `cd n` 時按下 `Tab` 鍵來自動補齊資料夾名稱
@@ -155,9 +191,9 @@ stages:
- ^/home/commander/notes$
responses:
- type: narrative
content:
- 你已經成功進入了 `notes` 資料夾。
- 接下來,請你試著在 `notes` 資料夾裡建立一個檔案,檔名為 `note.txt`。
content: |
你已經成功進入了 `notes` 資料夾。
接下來,請你試著在 `notes` 資料夾裡建立一個檔案,檔名為 `note.txt`。
hints:
- ➤ 輸入 `touch note.txt` 來建立一個檔案
@@ -167,13 +203,13 @@ stages:
- cd-notes
condition:
files:
- path: notes/note.txt
- path: /home/commander/notes/note.txt
type: file
responses:
- type: narrative
content:
- 非常好,你已經成功建立了 `note.txt` 檔案。
- 跟之前一樣,你可以使用 `ls` 指令來查看目前所在資料夾中有哪些檔案。
content: |
非常好,你已經成功建立了 `note.txt` 檔案。
跟之前一樣,你可以使用 `ls` 指令來查看目前所在資料夾中有哪些檔案。
- id: END
task: 使用 `ls` 指令來查看目前所在資料夾中有哪些檔案
@@ -186,7 +222,7 @@ stages:
- note.txt
responses:
- type: narrative
content:
- 你應該可以看到終端機上顯示了 `note.txt` 這個檔案。
- 恭喜你完成了這個關卡!
- 在下一個關卡中,你將學習如何複製檔案與資料夾。
content: |
你應該可以看到終端機上顯示了 `note.txt` 這個檔案。
恭喜你完成了這個關卡!
在下一個關卡中,你將學習如何複製檔案與資料夾。
+21
View File
@@ -0,0 +1,21 @@
#!/bin/sh
USERNAME=commander
echo "Initializing container for $USERNAME"
if ! id -u ${USERNAME} >/dev/null 2>&1; then
echo "Adding user $USERNAME"
adduser --disabled-password --gecos '' --shell /bin/zsh ${USERNAME} && \
find / -name ".gitkeep" -type f -exec rm -f {} +
echo "Adding public key for $USERNAME"
echo "Public key: $PUB_KEY"
PUB_KEY_PATH=/etc/ssh/authorized_keys/${USERNAME}
echo $PUB_KEY > ${PUB_KEY_PATH}
chmod 644 ${PUB_KEY_PATH}
fi
mkdir -p /run/sshd
echo "Starting SSH server"
/usr/sbin/sshd -D -e
+35 -78
View File
@@ -4,139 +4,96 @@ exceptions:
- '[\uff21-\uff3a\uff41-\uff5a]'
responses:
- type: narrative
content:
- '!! 請使用半形英文字母 !!'
content: |
!! 請使用半形英文字母 !!
- condition:
command:
- ' '
responses:
- type: narrative
content:
- '!! 請使用半形空格 !!'
- condition:
or:
- command:
- '`'
- command:
- \'
responses:
- type: narrative
content:
- '!! 不需要輸入上下引號 !!'
content: |
!! 請使用半形空格 !!
- condition:
command:
- ^echo\S$
- ^echo\S
responses:
- type: narrative
content:
- '!! `echo` 後面要加空格 !!'
content: |
!! `echo` 後面要加空格 !!
- condition:
command:
- ^cd\S$
- ^cd\S
responses:
- type: narrative
content:
- '!! `cd` 後面要加空格 !!'
content: |
!! `cd` 後面要加空格 !!
- condition:
command:
- ^ls\S$
- ^ls\S
responses:
- type: narrative
content:
- '!! `ls` 後面要加空格 !!'
content: |
!! `ls` 後面要加空格 !!
- condition:
command:
- ^cat\S$
- ^cat\S
responses:
- type: narrative
content:
- '!! `cat` 後面要加空格 !!'
content: |
!! `cat` 後面要加空格 !!
- condition:
command:
- ^touch\S$
- ^touch\S
responses:
- type: narrative
content:
- '!! `touch` 後面要加空格 !!'
content: |
!! `touch` 後面要加空格 !!
- condition:
not:
command:
- ^rmdir$
- ^rmdir
command:
- ^rm\S$
- ^rm\S
responses:
- type: narrative
content:
- '!! `rm` 後面要加空格 !!'
content: |
!! `rm` 後面要加空格 !!
- condition:
command:
- ^mv\S$
- ^mv\S
responses:
- type: narrative
content:
- '!! `mv` 後面要加空格 !!'
content: |
!! `mv` 後面要加空格 !!
- condition:
command:
- ^mkdir\S$
- ^mkdir\S
responses:
- type: narrative
content:
- '!! `mkdir` 後面要加空格 !!'
content: |
!! `mkdir` 後面要加空格 !!
- condition:
command:
- ^rmdir\S$
- ^rmdir\S
responses:
- type: narrative
content:
- '!! `rmdir` 後面要加空格 !!'
content: |
!! `rmdir` 後面要加空格 !!
- condition:
command:
- ^cp\S$
- ^cp\S
responses:
- type: narrative
content:
- '!! `cp` 後面要加空格 !!'
- condition:
command:
- ^[Ii1]s$
responses:
- type: narrative
content:
- '!! `ls` 的首字母是小寫的 `L` !!'
- condition:
command:
- 嗨
responses:
- type: narrative
content:
- '嗨~'
- condition:
command:
- folderl
responses:
- type: narrative
content:
- '`folder1` 的 `1` 是數字 `1`,不是小寫的 `L` !!'
- condition:
command:
- filel
responses:
- type: narrative
content:
- '`file1` 的 `1` 是數字 `1`,不是小寫的 `L` !!'
content: |
!! `cp` 後面要加空格 !!
+80
View File
@@ -0,0 +1,80 @@
# 執行檔案
## Outline
1. 什麼是可執行檔
2. 使用 `which` 指令查看執行檔的位置
3. 如何執行可執行檔
---
在我們先前的課程裡,已經使用了許多不同的指令,像是 `ls`, `cat`, `cp`, `mv`, `rm` 等。
這些指令,其實都是一個**可執行檔**,在你打指令的時候被作業系統執行。
所以大部分的指令,我們其實都能找到它在檔案系統裡的原始位置。
要查看一個指令它的檔案位置,可以使用 `which` 指令。
輸入 `which [指令名稱]` 就能夠查看指令的檔案位置了。
> 使用 `which ls` 來查看 `ls` 的路徑
---
你看到終端機顯示出 `/bin/ls` 這個路徑,它其實就是 `ls` 指令它檔案存在的位置。
`/bin` 是一個系統資料夾,裡面會儲存許多系統內建的程式,像是 `cat`, `cp` 等指令也都被存在這裡。
> 使用 `which cat` 查看 `cat` 的路徑
---
我們要執行一個可執行檔時,只要直接輸入它的路徑就可以執行它。
我們來試看看使用執行檔的路徑來執行指令。
> 輸入 `/bin/ls` 來查看當前的資料夾
---
你會看到它列出了我們資料夾內的檔案,你可以自己比較看看,跟單純打 `ls` 的結果會一模一樣。
它一樣可以使用參數。我們來用 `cat` 試試看。
> 輸入 `/bin/cat hello.txt` 來顯示 `hello.txt` 的內容
---
你會看到了 `hello.txt` 的內容,效果跟單純用 `cat` 一模一樣。
事實上,這是必然的,因為 `cat` 的檔案位置就是 `/bin/cat`,我們執行了同一個程式,當然會有同樣的結果。
其實指令,就是由 **一個執行檔** + **參數** 所構成。
我們之所以不用打 `/bin/ls`,而是只要打 `ls` 就能執行,是因為有 `PATH` 這個環境變數,幫我們預設好了終端機要去哪些*資料夾*找檔案。
但因為這超出了本次課程的範圍,關於 `PATH` 以及環境變數的議題,我們會在未來的課程再討論。
我們也可以執行不是內建的指令,像是現在資料夾中的 `dog` 檔案。
> 使用 `cat dog` 來查看 `dog` 的內容
---
你會看到這是一個用 `echo` 和 `cat` 所組成的簡單程式。
詳細的內容不用了解沒關係,功能是和 `cat` 一樣,用來印出檔案內容的程式。
但是這支程式,在沒有給要印出的檔案時,不會停留在輸入狀態。
當我們要執行一個檔案時,就是用指定路徑的方式。
那因為 `dog` 位在家目錄底下,所以牠的絕對路徑就是 `/home/commander/dog`,我們也可以用簡寫 `~/dog`。
> 輸入 `~/dog` 來執行 `dog` 檔案
---
你看到了終端機輸出這隻傲嬌的狗。
除了使用絕對路徑,很多時候,我們會處在跟程式相同的資料夾,這時使用相對路徑會更為便利。
但跟平常列出檔案時不一樣,我們為了區別它不是內建的指令,需要加上 `./` 在檔名前面。
`.` 在路徑中,代表的就是當前的資料夾。
那我們再試試看使用相對路徑,並讓牠接收一個檔案作為參數。
> 輸入 `./dog hello.txt` 來印出 `hello.txt` 的內容
---
你看到這隻狗在講了幾句話後也印出了 `hello.txt` 的內容了。
這個範例,其實就是一個簡單的自訂指令。
我們可以把一大串指令,寫在一個檔案裡讓它自動執行,幫我們處理一些複雜或是重複性的工作。
我們在使用別人寫的程式時,也常會用到這個技巧。
最後留一個小挑戰給你,請試著移動到 `commands` 資料夾後,再使用相對路徑執行裡面的 `lucky` 檔案。
+187
View File
@@ -0,0 +1,187 @@
title: 執行檔案
instruction: |
在這個關卡中,你將會學到:
1. 什麼是可執行檔
2. 使用 `which` 指令查看執行檔的位置
3. 如何執行可執行檔
requirements:
- remove
stages:
- id: start
task: 按下開始按鈕
type: start
condition:
command: ^echo start$
responses:
- content: |
在我們先前的課程裡,已經使用了許多不同的指令,像是 `ls`, `cat`, `cp`, `mv`, `rm` 等。
這些指令,其實都是一個**可執行檔**,在你打指令的時候被作業系統執行。
所以大部分的指令,我們其實都能找到它在檔案系統裡的原始位置。
要查看一個指令它的檔案位置,可以使用 `which` 指令。
輸入 `which [指令名稱]` 就能夠查看指令的檔案位置了。
hints:
- ➤ 使用 `which ls` 來查看 `ls` 的路徑
- id: which-ls
requirements:
- start
task: 使用 `which` 指令查看 `ls` 的路徑
condition:
command: ^which ls$
responses:
- content: |
你看到終端機顯示出 `/bin/ls` 這個路徑,它其實就是 `ls` 指令它檔案存在的位置。
`/bin` 是一個系統資料夾,裡面會儲存許多系統內建的程式,像是 `cat`, `cp` 等指令也都被存在這裡。
hints:
- ➤ 使用 `which cat` 查看 `cat` 的路徑
- id: which-cat
requirements:
- which-ls
task: 使用 `which` 指令查看 `cat` 的路徑
condition:
command: ^which cat$
responses:
- content: |
你看到了 `/bin/cat` 這個路徑,它就是 `cat` 指令它檔案存在的位置。
我們要執行一個可執行檔時,只要 **直接輸入它的路徑** 就可以執行它。
我們來試看看使用執行檔的路徑來執行指令。
在此之前,我們先試試看一般執行 `ls` 指令的結果。
hints:
- ➤ 輸入 `ls` 來查看當前的資料夾
- id: ls
requirements:
- which-cat
task: 使用 `ls` 指令查看當前的資料夾
condition:
command: ^ls$
responses:
- content: |
你看到了當前的資料夾內有 `commands` 資料夾和 `dog`, `hello.txt` 這兩個檔案。
我們再來試看看用 `ls` 的路徑來執行它。
hints:
- ➤ 輸入 `/bin/ls` 來查看當前的資料夾
- id: bin-ls
requirements:
- ls
task: 使用執行檔的絕對路徑來執行 `ls`
condition:
command: ^/bin/ls$
responses:
- content: |
你會看到它列出了我們資料夾內的檔案,你會發現它的輸出跟單純打 `ls` 的結果一模一樣。
它一樣可以使用參數。我們來用 `cat` 試試看。
hints:
- ➤ 輸入 `/bin/cat hello.txt` 來顯示 `hello.txt` 的內容
- id: bin-cat
requirements:
- bin-ls
task: 使用執行檔的絕對路徑來執行 `cat`
condition:
command: ^/bin/cat hello.txt$
responses:
- content: |
你看到了 `hello.txt` 的內容,跟單純使用 `cat` 一模一樣。
事實上,這是必然的,因為 `cat` 的檔案位置就是 `/bin/cat`,我們執行了同一個程式,當然會有同樣的結果。
因為一個指令,就是由 `執行檔 參數1 參數2 ...` 所構成。
`執行檔` 就是我們要執行的程式,像是 `ls`, `cat`, `which` 等。
`參數` 則是我們要提供給程式的資訊,像是接在 `cat` 後面的 `hello.txt`。
我們之所以不用打 `/bin/ls`,而是只要打 `ls` 就能執行,是因為有 `PATH` 這個環境變數,幫我們預設好了終端機要去哪些*資料夾*找檔案。
但因為這超出了本次課程的範圍,關於 `PATH` 以及環境變數的議題,我們會在未來的課程再討論。
接著我們來試著執行不是內建的指令。
現在資料夾中的 `dog` 檔案,是一個在這門課程所提供的自訂指令。
我們先來看看它是怎麼寫的。
hints:
- ➤ 使用 `cat dog` 來查看 `dog` 的內容
- id: cat-dog
requirements:
- bin-cat
task: 使用 `cat` 指令查看 `dog` 的內容
condition:
command: ^cat dog$
responses:
- content: |
你看到了這是一個用 `echo` 和 `sleep` 所組成的簡單程式。
詳細的內容不用了解沒關係,只是輸出一些文字而已。
當我們要執行一個檔案時,就是用指定路徑的方式。
也就是說 `執行檔` 就是 `dog` 的路徑,`參數` 在這個範例中不會使用到。
那因為 `dog` 位在家目錄底下,所以牠的絕對路徑就是 `/home/commander/dog`。
那在 `執行檔 參數` 這個格式下,我們要打的指令就會是
```
/home/commander/dog
```
hints:
- ➤ 輸入 `/home/commander/dog` 來執行 `dog` 檔案
- id: dog-abs
requirements:
- cat-dog
task: 使用絕對路徑來執行 `dog`
condition:
or:
- command: ^/home/commander/dog$
- command: ^~/dog$
responses:
- content: |
你看到了終端機輸出這隻傲嬌的狗。
除了使用絕對路徑,很多時候,我們會處在跟程式相同的資料夾,這時使用相對路徑會更為便利。
但跟平常列出檔案時不一樣,我們為了區別它不是內建的指令,需要加上 `./` 在檔名前面。
`.` 在路徑中,代表的就是當前的資料夾。
那我們再試試看使用相對路徑來執行 `dog` 檔案。
hints:
- ➤ 輸入 `./dog` 來執行 `dog` 檔案
- id: dog-rel
requirements:
- dog-abs
task: 使用相對路徑來執行 `dog`,並加上參數
condition:
pwd: /home/commander
command: ^./dog$
responses:
- content: |
你看到這隻狗執行了跟剛才一樣的結果。
這個範例,其實就是一個簡單的自訂指令。
我們可以把一大串指令,寫在一個檔案裡讓它自動執行,幫我們處理一些複雜或是重複性的工作。
我們在使用別人寫的程式時,也常會用到這個技巧。
最後留一個小挑戰給你,請試著先進入 `commands` 資料夾後,再使用相對路徑執行裡面的 `lucky` 檔案。
hints:
- ➤ 使用 `cd` 來進入資料夾
- ➤ 使用 `ls` 查看檔案
- ➤ 輸入 `./檔案名稱` 來執行檔案
- id: END
requirements:
- dog-rel
task: 使用相對路徑來執行 `lucky`
condition:
pwd: /home/commander/commands
command: ^./lucky$
responses:
- content: |
你看到了終端機輸出 `You are lucky!` 這個字串。
恭喜你,你已經完成了這個課程!
exceptions:
condition:
command: ^echo help$
responses:
- content: |
你需要先移動到 `commands` 資料夾,再使用相對路徑執行 `lucky` 檔案。
請先輸入 `cd commands` 來移動到 `commands` 資料夾,再使用相對路徑 `./lucky` 來執行 `lucky` 檔案。
+3
View File
@@ -0,0 +1,3 @@
#!/bin/sh
echo "I am SO LUCKY!!!"
+8
View File
@@ -0,0 +1,8 @@
#!/bin/sh
echo "你執行了 dog 檔案"
echo "汪汪汪"
sleep 1
echo "你知道嗎?"
sleep 1
echo "我比貓還厲害"
+1
View File
@@ -0,0 +1 @@
Hello! This is a file hello.txt
-3
View File
@@ -1,3 +0,0 @@
FROM linuxodyssey/quest-base
COPY home ${HOME}
+60 -56
View File
@@ -4,24 +4,22 @@ instruction: |
1. 如何使用 `ls` 查看資料夾的內容
2. 如何使用 `cd` 在資料夾之間移動
準備好就輸入 `echo start` 開始吧!
requirements:
- get-started
stages:
- id: start
task: 輸入 `echo start` 來開始教程
task: 按下 `開始` 按鈕開始教程
condition:
output:
- ^start$
command:
- ^echo start$
responses:
- content:
- 在終端機中,並沒有圖形介面可以讓你查看資料夾的內容。
- 但是你可以透過 `ls` 指令來查看資料夾的內容。
- '`ls` 指令是 list 的縮寫,也就是列出檔案的意思。'
- 在輸入 `ls` 指令後,終端機會輸出資料夾中包含的檔案和資料夾,右邊的檔案樹也會隨之改變。
- 現在,請你輸入 `ls` 指令,查看資料夾中有什麼東西。
- content: |
在終端機中,並沒有圖形介面可以讓你查看資料夾的內容。
但是你可以透過 `ls` 指令來查看資料夾的內容。
`ls` 指令(第一個字是小寫L)是 list 的簡寫,也就是列出檔案的意思。
在輸入 `ls` 指令後,終端機會輸出資料夾中包含的檔案和資料夾。
現在,請你輸入 `ls` 指令,查看資料夾中有什麼東西。
hints:
- ➤ 輸入 `ls` 並查看資料夾的內容
@@ -36,24 +34,23 @@ stages:
- condition:
not:
pwd:
- ^/home/commander$
- /home/commander
responses:
- type: narrative
content:
- 請先回到 `/home/commander/` 資料夾
- 輸入 `cd ~` 來返回 `/home/commander/` 資料夾
content: |
請先回到 `/home/commander/` 資料夾
輸入 `cd ~` 來返回 `/home/commander/` 資料夾
responses:
- content:
- 你應該能看到資料夾中的內容了。
- 在畫面右邊的檔案樹也有了改變。
- 可以看出,在這個資料夾中包含了兩個資料夾,分別是 `folder1` 和 `folder2`。
- content:
- 接下來,我要教你如何進入資料夾。
- '`cd` 指令是 change directory 的縮寫,也就是改變路徑的意思。'
- 你可以通過輸入 `cd [資料夾名稱]` 來進入資料夾。
- 例如你要進入 `folder1` 資料夾,你可以輸入
- '`cd folder1`。'
- 現在,請你進入 `folder1` 資料夾。
- content: |
你應該能看到資料夾中的內容了。
在畫面右邊的檔案樹也有了改變。
可以看出,在這個資料夾中包含了兩個資料夾,分別是 `folder1` 和 `folder2` 。
- content: |
接下來,我要教你如何進入資料夾。
`cd` 指令是 change directory 的縮寫,也就是改變路徑的意思。
你可以通過輸入 `cd [資料夾名稱]` 來進入資料夾。
例如你要進入 `folder1` 資料夾,你可以輸入 `cd folder1` 。
現在,請你進入 `folder1` 資料夾。
hints:
- ➤ 輸入 `cd folder1` 來進入 `folder1` 資料夾
@@ -65,30 +62,37 @@ stages:
pwd:
- ^/home/commander/folder1$
exceptions:
- condition:
command:
- folderl
responses:
- type: narrative
content: |
`folder1` 的最後是數字 `1` 不是字母 `l`。
- condition:
pwd:
- ^/home/commander$
responses:
- type: narrative
content:
- 輸入 `cd folder1` 來進入 `folder1` 資料夾
content: 輸入 `cd folder1` 來進入 `folder1` 資料夾
- condition:
not:
pwd:
- ^/home/commander$
responses:
- type: narrative
content:
- 請先回到 `/home/commander/` 資料夾
- 輸入 `cd ~` 來返回 `/home/commander/` 資料夾
content: |
請先回到 `/home/commander/` 資料夾
輸入 `cd ~` 來返回 `/home/commander/` 資料夾
再輸入 `cd folder1` 來進入 `folder1` 資料夾
responses:
- content:
- 你成功的進入 `folder1` 資料夾了。
- 你可以發現指令提示符從原本的
- '`commander:~ $` 變成了'
- '`commander:~/folder1 $` 。'
- 這表示你現在正位在 `folder1` 資料夾中。
- 現在,請查看 `folder1` 資料夾的內容。
- content: |
你成功的進入 `folder1` 資料夾了。
你可以發現指令提示符從原本的
`commander:~ $` 變成了
`commander:~/folder1 $` 。
這表示你現在正位在 `folder1` 資料夾中。
現在,請查看 `folder1` 資料夾的內容。
hints:
- ➤ 輸入 `ls` 查看資料夾的內容
@@ -102,11 +106,11 @@ stages:
command:
- ^ls$
responses:
- content:
- 你現在可以看到 `folder1` 資料夾中有兩的檔案,分別是 `file1.txt` 跟 `file2.txt`。
- 現在我們可以離開 `folder1` 回到原本的資料夾了。
- 你可以使用 `cd ..` 回到上一層資料夾。
- 這裡的 `..` 代表的是上一層的資料夾。
- content: |
你現在可以看到 `folder1` 資料夾中有兩個檔案,分別是 `file1.txt` 跟 `file2.txt`。
現在我們可以離開 `folder1` 回到原本的資料夾了。
你可以使用 `cd ..` 回到上一層資料夾。
這裡的 `..` 代表的是上一層的資料夾。
hints:
- ➤ 輸入 `cd ..` 回到上一層資料夾
@@ -118,9 +122,9 @@ stages:
pwd:
- ^/home/commander$
responses:
- content:
- 你成功的回到上一層資料夾了。
- 現在,請你剛才所學的指令,進入 `folder2` 資料夾,檢查 `folder2` 資料夾的內容,最後回到這個資料夾。
- content: |
你成功的回到上一層資料夾了。
現在,請你剛才所學的指令,進入 `folder2` 資料夾,檢查 `folder2` 資料夾的內容,最後回到這個資料夾。
hints:
- ➤ 使用 `cd` 指令進出資料夾
- ➤ 使用 `ls` 指令查看資料夾的內容
@@ -133,9 +137,9 @@ stages:
pwd:
- ^/home/commander/folder2$
responses:
- content:
- 你成功的進入 `folder2` 資料夾了。
- 現在,請你查看 `folder2` 資料夾的內容。
- content: |
你成功的進入 `folder2` 資料夾了。
現在,請你查看 `folder2` 資料夾的內容。
hints:
- ➤ 使用 `ls` 查看資料夾的內容
@@ -147,11 +151,11 @@ stages:
pwd:
- ^/home/commander/folder2$
command:
- ls
- ^ls$
responses:
- content:
- 你看到了 `folder2` 資料夾中的檔案,分別是 `file3.txt` 跟 `file4.txt`。
- 現在你可以離開 `folder2` 回到原本的資料夾了。
- content: |
你看到了 `folder2` 資料夾中的檔案,分別是 `file3.txt` 跟 `file4.txt`。
現在你可以離開 `folder2` 回到原本的資料夾了。
hints:
- ➤ 使用 `cd ..` 回到上一層資料夾
@@ -163,9 +167,9 @@ stages:
pwd:
- ^/home/commander$
responses:
- content:
- 你成功的回到原本的資料夾了。
- 恭喜你學會了 `ls` 和 `cd` 指令的用法。
- content: |
你成功的回到原本的資料夾了。
恭喜你學會了 `ls` 和 `cd` 指令的用法。
hints:
- ➤ 使用 `cd` 指令進出資料夾
- ➤ 使用 `ls` 指令查看資料夾的內容
+1
View File
@@ -1,3 +1,4 @@
echo start
echo hello
echo next
echo finish
+39 -46
View File
@@ -5,30 +5,20 @@ instruction: |
1. 如何使用這個網站
2. 如何使用終端機
在畫面的中間可以看到終端機和提示兩個區塊。
請你在終端機中的 `commander:~ $` 後面輸入 `echo start` 並按下 Enter 來開始教程。
!! 注意:不需要輸入上下引號 !!
stages:
- id: start
task: 輸入 `echo start` 來開始教程
task: 按下 `開始` 按鈕開始
condition:
output:
- ^start$
command:
- ^echo start$
responses:
- content:
- 你好,我是你的 Unix 助手,我叫做 Ada。我將會在之後協助你了解如何使用終端機。
- 現在所在的這個區塊就是終端機,你可以在這裡輸入指令來操作電腦。
- 在終端機中,你所看到的
- '`commander:~ $` 是指令提示符號,它能讓你知道現在可以輸入指令了。'
- 你必須將指令輸入在它的後方。
- 當你輸入完指令並按下 Enter 之後,終端機會執行你輸入的指令。
- 並且會將執行結果輸出在終端機的下一行。
- 這個終端機的功能和你在 Linux 電腦上看到的終端機是一樣的。
- 唯一的差別是,在這裡會有劇情和提示來協助你學習如何使用終端機。
- 在輸入指令之後,如果你看到用綠色 `=====` 組成的分隔線,代表在分隔線下方的內容是添加的內容,在真實的終端機中不會出現。
- 而終端機的輸出,是在綠色 `=====` 分隔線上方的白色內容。
- 現在請你輸入 `echo hello` 來看看會發生什麼事。
- content: |
在畫面的中下方的區塊是終端機,你可以在終端機裡輸入指令來操作電腦。
在終端機中,你所看到的 `commander:~ $` 叫做命令提示字串。
命令提示字串最後的錢字號 `$` 叫命令提示符,你必須將指令輸入在它的後方。
當你輸入完指令並按下 Enter 之後,終端機會執行你輸入的指令,並且會從終端機的下一行開始輸出指令的執行結果。
直到你看到新的 `commander:~ $` 出現時,代表你可以輸入下一個指令了。
現在請你輸入 `echo hello` 來看看會發生什麼事。
hints:
- ➤ 在 `commander:~ $` 後面輸入 `echo hello` 並按下 Enter
@@ -40,38 +30,41 @@ stages:
command:
- ^echo hello$
responses:
- content:
- 你應該可以看到終端機上顯示了:
- commander:~ $ echo hello
- hello
- 第一行的 `commander:~ $` 是指令提示符, `echo hello` 是你輸入的指令。
- 第二行的 `hello` 則是終端機的輸出。
- content:
- 現在你知道如何在終端機上輸入指令,以及查看終端機輸出的位置。
- 指令必須輸入在指令提示符號的後面,然而當指令提示符消失時,你就無法輸入指令了。
- 這時候你可以按下 `Ctrl + C` 來嘗試解決這個問題。
- 在終端機中, `Ctrl + C` 並不能用來複製,而是用來中斷目前正在執行的指令。
- 因此,如果你前一次的指令執行時卡住了,或是執行很久沒有反應,你可以按下 `Ctrl + C` 來中斷指令,讓你可以繼續輸入指令。
- 如果 `Ctrl + C` 也沒有辦法解決問題,可以按按看 `esc` 或 `q` 鍵。如果都沒用的話,按下畫面右下角的 `重來` 按鈕重新開始關卡。
- content:
- 在終端機下方會顯示提示,你可以用提示右上角的箭頭來查看之前的提示。
- 在畫面左邊的區域是關卡說明,你可以在這裡看到關卡的介紹,以及現在需要完成的任務。
- 在畫面右邊的區域是檔案樹,它會根據你所探索的資料夾發生變化,讓你更清楚檔案之間的位置關係。
- 畫面右上角的圖示分別是 `查看地圖`、`回報錯誤` 以及 `登出` 按鈕。
- content:
- 第一關的文字內容比較多,可以慢慢讀沒關係。
- 如果忘記了也可以隨時回來複習。
- 需要的話可以按下 `Enter` 來快速跳過劇情說明。
- 如果你已經讀完了上述內容,請輸入 `echo finish` 來結束這一關。
- content: |
你應該可以看到終端機上顯示了以下內容:
```
commander:~ $ echo hello
hello
```
第一行的 `commander:~ $` 是命令提示字串,接在後方的 `echo hello` 是你輸入的指令。
第二行的 `hello` 則是終端機的輸出結果。
你現在知道了如何在終端機上輸入指令,以及查看終端機輸出的位置。
現在請輸入 `echo next` 來繼續下一個步驟。
hints:
- ➤ 按下 `Ctrl + C` 能夠中斷指令
- ➤ 劇情進行時可以按下 `Enter` 來快速跳過
- ➤ 輸入 `echo next` 繼續下一個步驟
- id: echo-next
task: 在終端機輸入 `echo next`
requirements:
- echo-hello
condition:
command:
- ^echo next$
responses:
- content: |
`Ctrl + C` 在終端機中是一個很重要的快捷鍵,它可以用來中斷正在執行的指令,並產生一個新的命令提示字串,讓你可以繼續輸入指令。
如果指令執行很久沒有反應,或你因為其他原因想要中斷指令,你可以按下 `Ctrl + C` 來中斷指令。
又或者你輸入了錯誤的指令,卻懶得慢慢刪除,你也可以按下 `Ctrl + C` 來產生新的命令提示字串重新輸入指令。
如果你已經理解了剛才的說明,請輸入 `echo finish` 來結束這一關。
hints:
- ➤ 按下 `Ctrl + C` 能夠中斷正在執行的指令
- ➤ 按下 `Ctrl + C` 能夠產生新的命令提示字串
- ➤ 輸入 `echo finish` 來結束這一關
- id: END
task: 結束關卡
requirements:
- echo-hello
- echo-next
condition:
command:
- ^echo finish$
-3
View File
@@ -1,3 +0,0 @@
FROM linuxodyssey/quest-base
COPY home ${HOME}
+31 -31
View File
@@ -21,17 +21,17 @@ stages:
- 你聽到了一個聲音:
- type: dialogue
speaker: Unix 精靈
content:
- 你好,指令官,我是你的 Unix 精靈。我已在此恭候多時。
- 這個世界是在 3560000 時脈以前,由初代王建立了 Unix 律法,所形成的世界。然而在經過了好幾世代的王後,終於誕生了永恆之王——薩加(Saga),她比歷代的君王都更為強大,且從來不會衰老,使得這個世界變得前所未有的強大。
- 然而,外在世界一直不斷在改變,同時在面臨外敵的不斷攻擊,而薩加卻始終用同一套治理的手段。最終,在 160000 時脈前的一次入侵中,根部遭到攻陷,薩加遭到封印,而這個國家也陷入了黑暗。
- 由於長久以來依賴於薩加,世人已失去了「指令」的力量,即將走向衰敗和滅亡的命運。
- 你的任務,就是找回被世人遺忘的指令,奪回 Linux 之根,成為 Linux 之王。
- 首先,你必須要學會如何使用指令。
- 你要學習的第一個指令,是「搜索」的指令:`ls` (list)。 `ls` 可以用來查看一個目錄中有哪些檔案。
- 現在,請你輸入 `ls` 來查看目前的目錄下有哪些檔案。
hints: |
➤ 使用 `ls` 指令來查看目前的目錄下有哪些檔案。
content: |
你好,指令官,我是你的 Unix 精靈。我已在此恭候多時。
這個世界是在 3560000 時脈以前,由初代王建立了 Unix 律法,所形成的世界。然而在經過了好幾世代的王後,終於誕生了永恆之王——薩加(Saga),她比歷代的君王都更為強大,且從來不會衰老,使得這個世界變得前所未有的強大。
然而,外在世界一直不斷在改變,同時在面臨外敵的不斷攻擊,而薩加卻始終用同一套治理的手段。最終,在 160000 時脈前的一次入侵中,根部遭到攻陷,薩加遭到封印,而這個國家也陷入了黑暗。
由於長久以來依賴於薩加,世人已失去了「指令」的力量,即將走向衰敗和滅亡的命運。
你的任務,就是找回被世人遺忘的指令,奪回 Linux 之根,成為 Linux 之王。
首先,你必須要學會如何使用指令。
你要學習的第一個指令,是「搜索」的指令:`ls` (list)。 `ls` 可以用來查看一個目錄中有哪些檔案。
現在,請你輸入 `ls` 來查看目前的目錄下有哪些檔案。
hints:
- ➤ 使用 `ls` 指令來查看目前的目錄下有哪些檔案。
- id: find-scroll
task: 搜索卷軸
@@ -44,20 +44,20 @@ stages:
- ^ls$
responses:
- type: narrative
content:
- 一瞬間,視野變得清晰起來,你發現自己身處在一個石頭建築的房間裡。
- 你發現了一個檔案,檔名是 `forgotten-scroll.txt`。
content: |
一瞬間,視野變得清晰起來,你發現自己身處在一個石頭建築的房間裡。
你發現了一個檔案,檔名是 `forgotten-scroll.txt`。
- type: dialogue
speaker: Unix 精靈
content:
- 你找到了一個被遺忘的卷軸,上面寫著解除封印的咒語。
- 使用指令 `cat [ 檔案名稱 ]` (concatenate)來查看檔案內容。
- 我可以為你提供一些指令的提示,只要輸入指令的前幾個字元,然後按下 `Tab` 鍵,就可以看到提示了。
- 例如你只要輸入檔案名稱的前幾個字元,然後按下 `Tab` 鍵,就可以看到提示了。
hints: |
➤ 使用 `cat [ 檔案名稱 ]` 指令來查看檔案內容。
➤ 使用 `Tab` 鍵來取得指令提示。
➤ 如果卡在未知的情況,按下 `Ctrl + C` 嘗試離開。
content: |
你找到了一個被遺忘的卷軸,上面寫著解除封印的咒語。
使用指令 `cat [ 檔案名稱 ]` (concatenate)來查看檔案內容。
我可以為你提供一些指令的提示,只要輸入指令的前幾個字元,然後按下 `Tab` 鍵,就可以看到提示了。
例如你只要輸入檔案名稱的前幾個字元,然後按下 `Tab` 鍵,就可以看到提示了。
hints:
- ➤ 使用 `cat [ 檔案名稱 ]` 指令來查看檔案內容。
- ➤ 使用 `Tab` 鍵來取得指令提示。
- ➤ 如果卡在未知的情況,按下 `Ctrl + C` 嘗試離開。
- id: read-forgotten-scroll
task: 查看卷軸
@@ -71,11 +71,11 @@ stages:
responses:
- type: dialogue
speaker: Unix 精靈
content:
- 你找到的是一個被遺忘的卷軸,上面寫著解除封印的咒語。
- 使用你已經知道的 `echo [ 咒語 ]` 指令來詠唱咒語。
hints: |
➤ 輸入 `echo Hello World` 來詠唱咒語。
content: |
你找到的是一個被遺忘的卷軸,上面寫著解除封印的咒語。
使用你已經知道的 `echo [ 咒語 ]` 指令來詠唱咒語。
hints:
- ➤ 輸入 `echo Hello World` 來詠唱咒語。
- id: END
task: 解除封印
@@ -92,6 +92,6 @@ stages:
- 突然之間,你感覺到一股強大的力量從你的身體中湧出,你的身體開始發光,你的手中出現了一把魔法之劍。
- type: dialogue
speaker: Unix 精靈
content:
- 恭喜您,我的指令官,您已成功解除了封印。
- 請跟著在接下來的關卡,一步步取回 Linux 之根吧!
content: |
恭喜您,我的指令官,您已成功解除了封印。
請跟著在接下來的關卡,一步步取回 Linux 之根吧!
-3
View File
@@ -1,3 +0,0 @@
FROM linuxodyssey/quest-base
COPY --chown=${USERNAME} home ${HOME}
+2 -2
View File
@@ -1,9 +1,9 @@
echo start
echo continue
echo next
mv hello.txt notes
ls
ls notes
echo continue
echo next
mv world.txt wow.txt
ls
mv notes docs
+59 -71
View File
@@ -1,65 +1,63 @@
title: 移動檔案
instruction: |
在這個關卡中,你將會學到:
1. 如何用 `mv` 移動檔案與資料夾
準備好就輸入 `echo start` 開始吧!
1. 如何使用 `mv` 移動檔案與資料夾
requirements:
- create
stages:
- id: start
task: 輸入 `echo start` 來開始
task: 按下 `開始` 按鈕開始
condition:
command:
- ^echo start$
responses:
- type: narrative
content:
- 今天我們要學習如何移動檔案與資料夾。
- 現在資料夾裡有一個 `hello.txt` 跟一個 `world.txt`,以及一個 `notes` 資料夾。
- 請先用 `ls` 與 `cat` 來查看它們的內容。
- 看完之後,使用 `echo continue` 來繼續吧!
content: |
今天我們要學習如何移動檔案與資料夾。
現在資料夾裡有一個 `hello.txt` 跟一個 `world.txt`,以及一個 `notes` 資料夾。
請先用 `ls` 與 `cat` 來查看它們的內容。
看完之後,使用 `echo next` 來繼續吧!
hints:
- ➤ 用 `ls`、`ls notes` 來查看資料夾內的檔案
- ➤ 用 `cat hello.txt` 以及 `cat world.txt` 來查看檔案內容
- ➤ 完成後輸入 `echo continue` 來繼續
- ➤ 完成後輸入 `echo next` 來繼續
- id: continue
- id: next
requirements:
- start
task: 查看檔案內容,完成後輸入 `echo continue` 來繼續
task: 查看檔案內容,完成後輸入 `echo next` 來繼續
condition:
command:
- ^echo continue$
- ^echo next$
responses:
- type: narrative
content:
- 現在我們要來學習如何移動檔案與資料夾。
- '`mv` 指令是移動 move 的縮寫,可以用來移動檔案與資料夾。'
- 使用方式為 `mv [來源] [目的地]`。
- 我們先來將 `hello.txt` 移動到 `notes` 資料夾中吧!
content: |
現在我們要來學習如何移動檔案與資料夾。
`mv` 指令是移動 move 的縮寫,可以用來移動檔案與資料夾。
使用方式為 `mv [來源] [目的地]`。
我們先來將 `hello.txt` 移動到 `notes` 資料夾中吧!
hints:
- ➤ 使用 `mv hello.txt notes` 來將 `hello.txt` 移動到 `notes` 資料夾中
- id: mv-hello
requirements:
- continue
- next
task: 將 `hello.txt` 移動到 `notes` 資料夾中
condition:
command:
- ^mv hello.txt notes$
files:
- path: notes/hello.txt
- path: /home/commander/notes/hello.txt
type: file
- path: hello.txt
- path: /home/commander/hello.txt
exists: false
responses:
- type: narrative
content:
- 你做得很好!
- 我們用 `ls` 跟 `ls notes` 來查看一下資料夾內的檔案吧!
content: |
你做得很好!
我們用 `ls` 跟 `ls notes` 來查看一下資料夾內的檔案吧!
hints:
- ➤ 使用 `ls`、`ls notes` 來查看資料夾內的檔案
@@ -74,8 +72,8 @@ stages:
- ^ls$
responses:
- type: narrative
content:
- '`hello.txt` 已經不在資料夾中了!'
content: |
`hello.txt` 已經不在資料夾中了!
- id: ls-notes-hello
requirements:
@@ -90,43 +88,33 @@ stages:
- hello.txt
responses:
- type: narrative
content:
- '`hello.txt` 出現在 `notes` 資料夾中了!'
- id: continue-mv
requirements:
- ls-no-hello
- ls-notes-hello
task: 輸入 `echo continue` 來繼續
condition:
command:
- ^echo continue$
responses:
content: |
`hello.txt` 出現在 `notes` 資料夾中了!
- type: narrative
content:
- '`mv` 指令也可以用來更改檔案名稱。'
- '只要將目的地改成新的檔案名稱就可以了。'
- 現在我們要將 `world.txt` 更名為 `wow.txt`。
content: |
`mv` 指令也可以用來更改檔案名稱。
只要將目的地改成新的檔案名稱就可以了。
現在我們要將 `world.txt` 更名為 `wow.txt`。
hints:
- ➤ 使用 `mv world.txt wow.txt` 來將 `world.txt` 更名為 `wow.txt`
- id: mv-world
requirements:
- continue-mv
- ls-notes-hello
task: 將 `world.txt` 更名為 `wow.txt`
condition:
command:
- ^mv
files:
- path: wow.txt
- path: /home/commander/wow.txt
type: file
- path: world.txt
- path: /home/commander/world.txt
exists: false
responses:
- type: narrative
content:
- 你做得很好!
- 我們用 `ls` 來確認一下資料夾內的檔案吧!
content: |
你做得很好!
我們用 `ls` 來確認一下資料夾內的檔案吧!
hints:
- ➤ 使用 `ls` 來查看資料夾內的檔案
@@ -143,12 +131,12 @@ stages:
- wow.txt
responses:
- type: narrative
content:
- '`world.txt` 現在已經變成 `wow.txt` 了。'
- 接下來我們來學習如何移動資料夾吧!
- 移動資料夾非常簡單,方法跟移動檔案一樣。
- '`mv` 指令會自動將資料夾內的所有檔案一起移動'
- 我們先來將 `notes` 資料夾改名叫作 `docs` 吧!
content: |
`world.txt` 現在已經變成 `wow.txt` 了。
接下來我們來學習如何移動資料夾吧!
移動資料夾非常簡單,方法跟移動檔案一樣。
`mv` 指令會自動將資料夾內的所有檔案一起移動
我們先來將 `notes` 資料夾改名叫作 `docs` 吧!
hints:
- ➤ 使用 `mv notes docs` 來將 `notes` 資料夾改名叫作 `docs`
@@ -160,15 +148,15 @@ stages:
command:
- ^mv
files:
- path: docs
- path: /home/commander/docs
type: directory
- path: notes
- path: /home/commander/notes
exists: false
responses:
- type: narrative
content:
- 你做得很好!
- 我們用 `ls` 來確認一下資料夾內的檔案吧!
content: |
你做得很好!
我們用 `ls` 來確認一下資料夾內的檔案吧!
hints:
- ➤ 使用 `ls` 來查看資料夾內的檔案
@@ -185,11 +173,11 @@ stages:
- docs
responses:
- type: narrative
content:
- '`notes` 資料夾已經變成 `docs` 了。'
- 那麼最後來考考你:
- 試著將 `docs/hello.txt` 移動到家目錄底下的 `hi.txt`。
- 如果你不知道怎麼做,可以輸入 `echo hint` 來取得提示。
content: |
`notes` 資料夾已經變成 `docs` 了。
那麼最後來考考你:
試著將 `docs/hello.txt` 移動到家目錄底下的 `hi.txt`。
如果你不知道怎麼做,可以輸入 `echo hint` 來取得提示。
- id: END
requirements:
@@ -199,9 +187,9 @@ stages:
command:
- ^mv
files:
- path: hi.txt
- path: /home/commander/hi.txt
type: file
- path: docs/hello.txt
- path: /home/commander/docs/hello.txt
exists: false
exceptions:
- condition:
@@ -209,12 +197,12 @@ stages:
- ^echo hint$
responses:
- type: narrative
content:
- 你可以使用 `mv docs/hello.txt hi.txt` 來完成這個任務。
content: |
你可以使用 `mv docs/hello.txt hi.txt` 來完成這個任務。
hints:
- ➤ 使用 `mv docs/hello.txt hi.txt` 來將 `docs/hello.txt` 移動到家目錄底下的 `hi.txt`
responses:
- type: narrative
content:
- 你做得很好!
- 你已經學會如何移動檔案與資料夾了!
content: |
你做得很好!
你已經學會如何移動檔案與資料夾了!
-3
View File
@@ -1,3 +0,0 @@
FROM linuxodyssey/quest-base
COPY home ${HOME}
+51 -53
View File
@@ -4,24 +4,22 @@ instruction: |
1. 絕對路徑和相對路徑
2. 如何使用 `pwd` 顯示目前的路徑
準備好就輸入 `echo start` 開始吧!
requirements:
- cast
- explore
stages:
- id: start
task: 輸入 `echo start` 來開始教程
task: 按下 `開始` 按鈕開始教程
condition:
output:
- ^start$
command:
- ^echo start$
responses:
- content:
- 在 Linux 系統中,每個資料夾和檔案都有獨一無二的路徑。
- 而路徑又分為相對路徑和絕對路徑。
- 相對路徑是從目前所在的資料夾開始的路徑,而絕對路徑則是從根目錄開始的路徑。
- 請你先用 `ls` 指令查看這個資料夾中的檔案。
- content: |
在 Linux 系統中,每個資料夾和檔案都有獨一無二的路徑。
而路徑又分為相對路徑和絕對路徑。
相對路徑是從目前所在的資料夾開始的路徑,而絕對路徑則是從根目錄開始的路徑。
請你先用 `ls` 指令查看這個資料夾中的檔案。
- id: ls
task: 查看資料夾中的檔案
@@ -33,8 +31,8 @@ stages:
command:
- ^ls$
responses:
- content:
- 現在你使用 `cd` 指令進入 `folder1` 資料夾。
- content: |
現在你使用 `cd` 指令進入 `folder1` 資料夾。
- id: cd-folder1
task: 進入 `folder1` 資料夾
@@ -44,14 +42,14 @@ stages:
pwd:
- ^/home/commander/folder1$
responses:
- content:
- 你進入了 `folder1` 資料夾。
- 在進入 `folder1` 資料夾時,使用的 `cd folder1` 中的 `folder1` 就是相對路徑。
- 相同的道理 `cd ..` 中的 `..` 也是相對路徑。
- 相對路徑可以不只有一層資料夾。
- 例如:現在想要進入 `folder2` 資料夾的話,可以使用 `cd ..` 回到上一層資料夾,再使用 `cd folder2` 進入 `folder2` 資料夾。
- 然而,你也可以用 `/` 將 `..` 和 `folder2` 依序連接起來,使用 `cd ../folder2` 來一次進入 `folder2` 資料夾。
- 現在試著用這個方式進入 `folder2` 資料夾看看吧。
- content: |
你進入了 `folder1` 資料夾。
在進入 `folder1` 資料夾時,使用的 `cd folder1` 中的 `folder1` 就是相對路徑。
相同的道理 `cd ..` 中的 `..` 也是相對路徑。
相對路徑可以不只有一層資料夾。
例如:現在想要進入 `folder2` 資料夾的話,可以使用 `cd ..` 回到上一層資料夾,再使用 `cd folder2` 進入 `folder2` 資料夾。
然而,你也可以用 `/` 將 `..` 和 `folder2` 依序連接起來,使用 `cd ../folder2` 來一次進入 `folder2` 資料夾。
現在試著用這個方式進入 `folder2` 資料夾看看吧。
hints:
- ➤ 請輸入 `cd ../folder2` 來進入 `folder2` 資料夾。
@@ -68,14 +66,14 @@ stages:
- ^/home/commander$
responses:
- type: narrative
content:
- 輸入 `cd folder2` 來進入 `folder2` 資料夾
content: |
輸入 `cd folder2` 來進入 `folder2` 資料夾
responses:
- content:
- 你成功的用相對路徑進入了 `folder2` 資料夾。
- 而你也能夠在 `ls` 後加上相對路徑來查看其他資料夾的內容。
- 例如:現在你想要查看 `folder1` 資料夾中有哪些檔案,你可以使用 `ls ../folder1` 來查看。
- 試著用這個方式查看 `folder1` 資料夾中的檔案吧。
- content: |
你成功的用相對路徑進入了 `folder2` 資料夾。
而你也能夠在 `ls` 後加上相對路徑來查看其他資料夾的內容。
例如:現在你想要查看 `folder1` 資料夾中有哪些檔案,你可以使用 `ls ../folder1` 來查看。
試著用這個方式查看 `folder1` 資料夾中的檔案吧。
hints:
- ➤ 請輸入 `ls ../folder1` 來查看 `folder1` 資料夾中的檔案。
@@ -93,16 +91,16 @@ stages:
- ^/home/commander/folder2$
responses:
- type: narrative
content:
- 進到 `folder1` 資料夾並用 `ls` 查看內容。
content: |
進到 `folder1` 資料夾並用 `ls` 查看內容。
responses:
- content:
- 很好,你現在知道如何運用相對路徑了。
- 接下來要介紹的是絕對路徑。
- 絕對路徑是從根目錄開始的路徑,根目錄是位於檔案樹的最上層的資料夾。
- 你可以使用 `pwd` 來查看目前所在的絕對路徑。
- '`pwd` 的意思是 `print working directory`,也就是顯示目前所在的路徑。'
- 現在請你使用 `pwd` 來查看目前所在的絕對路徑。
- content: |
很好,你現在知道如何運用相對路徑了。
接下來要介紹的是絕對路徑。
絕對路徑是從根目錄開始的路徑,根目錄是位於檔案樹的最上層的資料夾。
你可以使用 `pwd` 來查看目前所在的絕對路徑。
`pwd` 的意思是 `print working directory`,也就是顯示目前所在的路徑。
現在請你使用 `pwd` 來查看目前所在的絕對路徑。
hints:
- ➤ 輸入 `pwd` 查看目前所在的絕對路徑
@@ -122,17 +120,17 @@ stages:
- ^/home/commander/folder2$
responses:
- type: narrative
content:
- 請先回到 `folder2` 資料夾,並用 `pwd` 來查看目前所在的絕對路徑
content: |
請先回到 `folder2` 資料夾,並用 `pwd` 來查看目前所在的絕對路徑
responses:
- content:
- 你可以看到你現在的絕對路徑是 `/home/commander/folder2`。
- 而絕對路徑其實也顯示在你的命令提示符中。
- '`commander:~/folder2 $` 中的 `~/folder2` 就是你的絕對路徑。'
- 而 `~` 則是 `/home/commander` 這個絕對路徑的縮寫,又稱為家目錄,你每次遊戲都會從這裡開始。
- '`ls` 和 `cd` 指令也可以使用絕對路徑。'
- 例如:你可以使用 `ls ~` 來查看家目錄的內容,或使用 `cd ~` 來回到家目錄。
- 現在請你使用 `ls ~` 來查看家目錄的內容。
- content: |
你可以看到你現在的絕對路徑是 `/home/commander/folder2`。
而絕對路徑其實也顯示在你的命令提示符中。
`commander:~/folder2 $` 中的 `~/folder2` 就是你的絕對路徑。
而 `~` 則是 `/home/commander` 這個絕對路徑的縮寫,又稱為家目錄,你每次遊戲都會從這裡開始。
`ls` 和 `cd` 指令也可以使用絕對路徑。
例如:你可以使用 `ls ~` 來查看家目錄的內容,或使用 `cd ~` 來回到家目錄。
現在請你使用 `ls ~` 來查看家目錄的內容。
hints:
- ➤ 輸入 `ls ~` 來查看家目錄的內容
@@ -144,8 +142,8 @@ stages:
command:
- ^ls ~$
responses:
- content:
- 現在請使用 `cd ~` 回到家目錄。
- content: |
現在請使用 `cd ~` 回到家目錄。
hints:
- ➤ 輸入 `cd ~` 來回到家目錄
@@ -162,9 +160,9 @@ stages:
- ^/home/commander$
responses:
- type: narrative
content:
- 請使用 `cd ~` 回到家目錄
content: |
請使用 `cd ~` 回到家目錄
responses:
- content:
- 你回到家目錄了。
- 恭喜!現在你已經知道如何運用絕對路徑和相對路徑,以及查看目前所在的絕對路徑了。
- content: |
你回到家目錄了。
恭喜!現在你已經知道如何運用絕對路徑和相對路徑,以及查看目前所在的絕對路徑了。
-3
View File
@@ -1,3 +0,0 @@
FROM linuxodyssey/quest-base
COPY home ${HOME}
+28 -31
View File
@@ -3,24 +3,22 @@ instruction: |
在這個關卡中,你將會學到:
1. 如何使用 `cat` 查看檔案的內容
準備好就輸入 `echo start` 開始吧!
requirements:
- path
stages:
- id: start
task: 輸入 `echo start` 來開始教程
task: 按下 `開始` 按鈕開始教程
condition:
output:
- ^start$
command:
- ^echo start$
responses:
- content:
- 在終端機中,並沒有圖形介面可以讓你查看檔案的內容。
- 但是你可以透過 `cat` 指令來查看檔案的內容。
- '`cat` 指令是 concatenate 的縮寫,也就是串接的意思。'
- 在輸入 `cat [檔案名稱]` 指令後,終端機會輸出檔案的內容。
- 請你先查看這個資料夾中哪些檔案。
- content: |
在終端機中,並沒有圖形介面可以讓你查看檔案的內容。
但是你可以透過 `cat` 指令來查看檔案的內容。
`cat` 指令是 concatenate 的縮寫,也就是串接的意思。
在輸入 `cat [檔案名稱]` 指令後,終端機會輸出檔案的內容。
請你先查看這個資料夾中哪些檔案。
hints:
- ➤ 請輸入 `ls` 來查看這個資料夾中的檔案。
@@ -34,9 +32,9 @@ stages:
command:
- ^ls$
responses:
- content:
- 這個資料夾中有一個檔案和一個資料夾。
- 現在你可以使用 `cat` 指令來查看 `file1.txt` 的內容。
- content: |
這個資料夾中有一個檔案和一個資料夾。
現在你可以使用 `cat` 指令來查看 `file1.txt` 的內容。
hints:
- ➤ 請輸入 `cat file1.txt` 來查看檔案的內容。
@@ -50,10 +48,10 @@ stages:
command:
- ^cat file1.txt$
responses:
- content:
- 你應該能看到檔案的內容了。
- '`cat` 指令也可以使用路徑來查看檔案內容'
- 請你先用 `ls folder` 查看資料夾內的檔案。
- content: |
你應該能看到檔案的內容了。
`cat` 指令也可以使用路徑來查看檔案內容
請你先用 `ls folder` 查看資料夾內的檔案。
hints:
- ➤ 輸入 `ls folder` 查看資料夾內的檔案
@@ -71,13 +69,13 @@ stages:
not:
pwd:
- ^/home/commander$
content:
- 請留在 `/home/commander` 資料夾中。
- 請輸入 `cd ~` 回到 `/home/commander` 資料夾。
content: |
請留在 `/home/commander` 資料夾中。
請輸入 `cd ~` 回到 `/home/commander` 資料夾。
responses:
- content:
- 你現在知道 `folder` 資料夾的內容了。
- 請用 `cat` 指令來查看 `folder` 資料夾中的 `file.txt` 檔案。
- content: |
你現在知道 `folder` 資料夾的內容了。
請用 `cat` 指令來查看 `folder` 資料夾中的 `file.txt` 檔案。
hints:
- ➤ 輸入 `cat folder/file.txt` 查看 `file.txt` 檔案的內容。
@@ -97,11 +95,10 @@ stages:
- ^/home/commander$
responses:
- type: narrative
content:
- 請留在 `/home/commander` 資料夾中。
- 請輸入 `cd ~` 回到 `/home/commander` 資料夾。
content: |
請留在 `/home/commander` 資料夾中。
請輸入 `cd ~` 回到 `/home/commander` 資料夾。
responses:
- type: narrative
content:
- 你成功地查看到 `file.txt` 的內容了。
- 你已經會使用 `cat` 指令查看檔案的內容了。
- content: |
你成功地查看到 `file.txt` 的內容了。
你已經會使用 `cat` 指令查看檔案的內容了。
-4
View File
@@ -1,4 +0,0 @@
FROM linuxodyssey/quest-base
COPY --chown=${USERNAME} home ${HOME}
RUN mkdir empty
+1
View File
@@ -1,4 +1,5 @@
echo start
ls
rm hello.txt
ls
rm world.txt wow.txt
+91 -89
View File
@@ -1,12 +1,9 @@
title: 刪除檔案與資料夾
instruction: |
在這個關卡中,你將會學到:
1. 用 `rm` 指令刪除檔案
2. 用 `rmdir` 與資料夾
3. 用 `rm -r` 刪除資料夾與它的所有檔案
現在資料夾裡有一些檔案與資料夾,請你使用 `ls` 跟 `cat` 來查看它們的內容。
準備好就輸入 `echo start` 開始吧!
1. 如何使用 `rm` 指令刪除檔案
2. 如何使用 `rmdir` 刪除空資料夾
3. 如何使用 `rm -r` 刪除資料夾與其中的所有檔案
requirements:
- copy
@@ -14,33 +11,44 @@ requirements:
stages:
- id: start
task: 輸入 `echo start` 來開始
task: 按下 `開始` 按鈕開始
condition:
command:
- ^echo
output:
- start
- ^echo start$
responses:
- content:
- 今天我們要學習如何刪除檔案與資料夾。
- '首先要來學習 `rm` 指令。`rm` 指令可以用來刪除檔案。使用方式是 `rm [檔案名稱]`。'
- '現在請你使用 `rm` 指令刪除 `hello.txt`。'
- content: |
今天我們要學習如何刪除檔案與資料夾。
請先使用 `ls` 指令查看資料夾內容。
hints:
- ➤ 使用 `ls` 來查看資料夾內容。
- id: ls
requirements:
- start
task: 使用 `ls` 查看資料夾內容
condition:
command:
- ^ls$
responses:
- content: |
首先要來學習 `rm` 指令。`rm` 指令可以用來刪除檔案。使用方式是 `rm [檔案名稱]`。
現在請你使用 `rm` 指令刪除 `hello.txt`。
hints:
- ➤ 使用 `rm hello.txt` 來刪除 `hello.txt`。
- id: rm-hello
requirements:
- start
- ls
task: 使用 `rm` 刪除 `hello.txt`
condition:
command:
- ^rm
- ^rm\s
files:
- path: hello.txt
- path: /home/commander/hello.txt
exists: false
responses:
- content:
- '很好!現在請你使用 `ls` 指令來查看資料夾內容。'
- content: |
很好!現在請你使用 `ls` 指令來查看資料夾內容。
- id: ls-no-hello
requirements:
@@ -48,15 +56,15 @@ stages:
task: 使用 `ls` 查看資料夾內容
condition:
command:
- ^ls
- ^ls$
files:
- path: hello.txt
- path: /home/commander/hello.txt
exists: false
responses:
- content:
- '你會發現 `hello.txt` 已經不見了。'
- '`rm` 也可以同時刪除多個檔案,只要把檔案名稱用空白隔開就可以了,也就是 `rm [檔案1] [檔案2] ...`。'
- 現在請你使用 `rm` 刪除 `world.txt` 與 `wow.txt`。
- content: |
你會發現 `hello.txt` 已經不見了。
`rm` 也可以同時刪除多個檔案,只要把檔案名稱用空白隔開就可以了,也就是 `rm [檔案1] [檔案2] ...`。
現在請你使用 `rm` 刪除 `world.txt` 與 `wow.txt`。
hints:
- ➤ 使用 `rm world.txt wow.txt` 來刪除 `world.txt` 與 `wow.txt`。
- ➤ 檔案名稱之間要用空白隔開。
@@ -70,13 +78,13 @@ stages:
command:
- ^rm
files:
- path: world.txt
- path: /home/commander/world.txt
exists: false
- path: wow.txt
- path: /home/commander/wow.txt
exists: false
responses:
- content:
- '很好!我們一樣用 `ls` 指令確認一下資料夾內容。'
- content: |
很好!我們一樣用 `ls` 指令確認一下資料夾內容。
hints:
- ➤ 使用 `ls` 來查看資料夾內容。
@@ -88,10 +96,10 @@ stages:
command:
- ^ls$
responses:
- content:
- '你會發現 `world.txt` 與 `wow.txt` 已經不見了。'
- '現在我們來學習 `rmdir` 指令。`rmdir` 指令可以用來刪除資料夾。使用方式是 `rmdir [資料夾名稱]`。'
- '現在請你使用 `rmdir` 指令刪除 `empty` 資料夾。'
- content: |
你會發現 `world.txt` 與 `wow.txt` 已經不見了。
現在我們來學習 `rmdir` 指令。`rmdir` 指令可以用來刪除資料夾。使用方式是 `rmdir [資料夾名稱]`。
現在請你使用 `rmdir` 指令刪除 `empty` 資料夾。
hints:
- ➤ 使用 `rmdir empty` 來刪除 `empty` 資料夾。
@@ -101,13 +109,13 @@ stages:
task: 使用 `rmdir` 刪除 `empty` 資料夾
condition:
command:
- ^rmdir
- ^rmdir empty$
files:
- path: empty
- path: /home/commander/empty
exists: false
responses:
- content:
- '很好!現在請你使用 `ls` 指令來查看資料夾內容。'
- content: |
很好!現在請你使用 `ls` 指令來查看資料夾內容。
- id: ls-no-empty
requirements:
@@ -117,9 +125,9 @@ stages:
command:
- ^ls$
responses:
- content:
- '你會發現 `empty` 資料夾已經不見了。'
- '現在請你試試看 `rmdir` 指令刪除 `notes` 資料夾。'
- content: |
你會發現 `empty` 資料夾已經不見了。
現在請你試試看 `rmdir` 指令刪除 `notes` 資料夾。
hints:
- ➤ 使用 `rmdir notes` 來刪除 `notes` 資料夾
@@ -131,16 +139,16 @@ stages:
command:
- ^rmdir notes$
files:
- path: notes
- path: /home/commander/notes
type: folder
exists: true
responses:
- content:
- 指令執行失敗了!
- '你會發現 `notes` 資料夾還在。'
- '這是因為 `rmdir` 指令只能刪除空的資料夾。'
- 我們先來將 `notes` 資料夾的檔案刪除再來試一次。
- '現在請你使用 `rm` 指令刪除 `notes` 資料夾內的檔案。'
- content: |
指令執行失敗了!
你會發現 `notes` 資料夾還在。
這是因為 `rmdir` 指令只能刪除空的資料夾。
我們先來將 `notes` 資料夾的檔案刪除再來試一次。
現在請你使用 `rm` 指令刪除 `notes` 資料夾內的檔案。
hints:
- ➤ 使用 `rm notes/[檔案名稱]` 來刪除 `notes` 資料夾內的檔案。
- ➤ 你可能需要使用 `ls notes` 來查看 `notes` 資料夾內有哪些檔案。
@@ -153,41 +161,39 @@ stages:
command:
- ^rm
files:
- path: notes
- path: /home/commander/notes
type: folder
exists: true
- path: notes/note.txt
- path: /home/commander/notes/note.txt
exists: false
exceptions:
- condition:
command:
- ^rm notes/\[.*\]
responses:
- content:
- '你好像理解錯了。'
- 這邊中括號包起來 `[檔案名稱]` 是參數的意思,需要你自己填入檔案的名稱。
- 實際打指令的時候,不要打中括號 `[]` 喔!
- '例如,如果要刪除 `notes` 資料夾內的 `note.txt` 檔案,指令應該要是 `rm notes/note.txt`。'
- 請先用 `ls notes` 確認 `notes` 資料夾內有哪些檔案,再來試試看吧!
- content: |
你好像理解錯了。
這邊中括號包起來 `[檔案名稱]` 是參數的意思,需要你自己填入檔案的名稱。
實際打指令的時候,不要打中括號 `[]` 喔!
例如,如果要刪除 `notes` 資料夾內的 `note.txt` 檔案,指令應該要是 `rm notes/note.txt`。
請先用 `ls notes` 確認 `notes` 資料夾內有哪些檔案,再來試試看吧!
- condition:
command:
- ^rm
error:
- 'No such file or directory'
- ^rmdir notes$
responses:
- content:
- 這個錯誤的意思是找不到檔案
- '請先用 `ls notes` 確認 `notes` 資料夾內有哪些檔案,再來試試看吧!'
- content: |
這個錯誤的意思是找不到檔案
請先用 `ls notes` 確認 `notes` 資料夾內有哪些檔案,再來試試看吧!
- condition:
command:
- ^ls notes$
responses:
- content:
- '`notes` 資料夾中有著 `note.txt` 檔案。'
- 那我們就使用 `rm notes/note.txt` 來刪除 `note.txt` 檔案吧!
- content: |
`notes` 資料夾中有著 `note.txt` 檔案。
那我們就使用 `rm notes/note.txt` 來刪除 `note.txt` 檔案吧!
responses:
- content:
- '很好!現在我們再使用 `rmdir` 指令刪除 `notes` 資料夾。'
- content: |
很好!現在我們再使用 `rmdir` 指令刪除 `notes` 資料夾。
hints:
- ➤ 使用 `rmdir notes` 來刪除 `notes` 資料夾。
@@ -196,16 +202,14 @@ stages:
- rm-notes-content
task: 使用 `rmdir` 刪除 `notes` 資料夾
condition:
command:
- ^rmdir
files:
- path: notes
- path: /home/commander/notes
exists: false
responses:
- content:
- '很好!`notes` 資料夾已經被刪除了。'
- 接下來我們來刪除 `trash` 資料夾。
- 先使用 `ls` 指令查看一下 `trash` 資料夾內容。
- content: |
很好!`notes` 資料夾已經被刪除了。
接下來我們來刪除 `trash` 資料夾。
先使用 `ls` 指令查看一下 `trash` 資料夾內容。
hints:
- ➤ 使用 `ls trash` 來查看 `trash` 中的檔案。
@@ -215,16 +219,14 @@ stages:
task: 使用 `ls` 查看 `trash` 資料夾內容
condition:
command:
- ^ls
output:
- garbage.txt
- ^ls trash$
responses:
- content:
- 天啊!`trash` 資料夾裡有好多檔案,甚至還有其他的資料夾!
- 如果今天資料夾中有很多檔案與資料夾,我們不想一個一個刪除,該怎麼辦呢?
- 跟 `cp` 的時候一樣,這時候我們可以加上 `-r` 的選項來刪除資料夾與它的所有檔案。
- '`-r` 的意思是遞迴(recursive),也就是會把資料夾中的所有檔案都刪除。'
- 我們來試試看吧!
- content: |
天啊!`trash` 資料夾裡有好多檔案,甚至還有其他的資料夾!
如果今天資料夾中有很多檔案與資料夾,我們不想一個一個刪除,該怎麼辦呢?
跟 `cp` 的時候一樣,這時候我們可以加上 `-r` 的選項來刪除資料夾與它的所有檔案。
`-r` 的意思是遞迴(recursive),也就是會把資料夾中的所有檔案都刪除。
我們來試試看吧!
hints:
- ➤ 使用 `rm -r trash` 來刪除 `trash` 資料夾。
@@ -234,13 +236,13 @@ stages:
task: 使用 `rm -r` 刪除 `trash` 資料夾
condition:
command:
- ^rm -r
- ^rm -r trash$
files:
- path: trash
- path: /home/commander/trash
exists: false
responses:
- content:
- '很好!現在請你使用 `ls` 指令查看資料夾內容。'
- content: |
很好!現在請你使用 `ls` 指令查看資料夾內容。
hints:
- ➤ 使用 `ls` 來查看資料夾內容。
@@ -252,6 +254,6 @@ stages:
command:
- ^ls$
responses:
- content:
- '`trash` 資料夾已經不見了。'
- 恭喜你!你已經學會如何刪除檔案與資料夾了!
- content: |
`trash` 資料夾已經不見了。
恭喜你!你已經學會如何刪除檔案與資料夾了!
View File
Whitespace-only changes.
+196
View File
@@ -0,0 +1,196 @@
title: Tab 自動補全
instruction: |
在這個關卡,你將會學到
1. 如何使用 Tab 自動補全路徑
2. 出現衝突時如何處理
按下中間的按鈕來開始這個關卡。
requirements:
- read
stages:
- id: start
task: 按下開始按鈕開始關卡
condition:
command:
- ^echo start$
responses:
- content: |
在終端機裡,所有的操作都是用文字進行。
然而,打字很花時間,而且只要一個字打錯,指令就會執行失敗。
因些終端機提供「自動補全」的功能,自動幫你完成檔案路徑、指令名稱、參數名稱,節省你的時間,也避免輸入錯誤。
在開始練習之前,我們先來看看家目錄下有哪些檔案。
hints:
- ➤ 使用 `ls` 查看檔案列表
- id: ls
task: 使用 `ls` 查看檔案列表
requirements:
- start
condition:
command:
- ^ls$
responses:
- content: |
你看到了這個資料夾中充滿了超級長和有錯字的檔案名稱,如果這些都要我們一個一個字輸入,肯定會很痛苦。
但不要緊,只要使用自動補全,檔名不論多長都能輕鬆輸入。
使用自動補全的方法是,**先輸入部分的檔名,再按下 Tab**
(Tab 是 Q 左邊的按鍵)
例如要補全 `SuperSecretPlansForWorldDomination.txt`,你可以先輸入 `Su` 再按下 Tab,終端機就會幫你打完剩下的檔名了。
我們試看看印出 `SuperSecretPlansForWorldDomination.txt` 這個檔案的內容。
hints:
- ➤ 使用 `cat SuperSecretPlansForWorldDomination.txt` 來印出檔案內容
- ➤ 在輸入 `cat Su` 之後按下 Tab 來自動補全檔名,完成後按 Enter 就能執行指令
- id: cat_super_secret
task: 使用 `cat` 印出 SuperSecretPlansForWorldDomination.txt 的內容
requirements:
- ls
condition:
pwd:
- ^/home/commander$
command:
- ^cat SuperSecretPlansForWorldDomination.txt$
responses:
- content: |
你看到了終端機自動幫你補全了 `SuperSecretPlansForWorldDomination.txt`,就算是很長的檔名,也不用怕打錯字。
開頭不論你打了幾個字都無所謂,你可以只打 `S`、`Su`、`Sup`、`Super` 或甚至完全不打字都沒關係。
但是你打的字越少,就越容易跟其他的檔案重複,這時候就要做衝突處理。
關於衝突處理,我們會在待會練習。
自動補全也可以用來對付拼字錯誤,像是 `ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt` 這個檔案充滿了錯字,任誰來打都難保不會失手。
這一次,請你一樣用 `cat` 來試著印出 `ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt` 的內容。
hints:
- ➤ 輸入 `cat ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt` 來印出檔案內容
- ➤ 輸入 `cat Thsi` 之後按下 Tab 做自動補全
- ➤ 試試看輸入更少的字元就按 Tab 會有什麼樣的結果
- id: cat_typo
task: 使用 `cat` 印出 ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt 的內容
requirements:
- cat_super_secret
condition:
pwd:
- ^/home/commander$
command:
- ^cat ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt$
responses:
- content: |
你看到了這個充滿錯字的檔案了。
只要使用自動補全,不管是錯字、大小寫變化、還是隨機亂碼都不再是困擾了。
讓我們再練習一個,這次請你查看 `ThingsIWillOrganizeLaterWhenIHaveTime` 資料夾中的檔案。
一樣,輸入前幾個字,然後按 Tab 自動補全。
hints:
- ➤ 輸入 `ls ThingsIWillOrganizeLaterWhenIHaveTime` 查看資料夾中的檔案
- ➤ 輸入 `ls Thing` 之後按下 Tab 做自動補全
- id: ls_things
task: 使用 `ls` 查看 ThingsIWillOrganizeLaterWhenIHaveTime 資料夾中的檔案
requirements:
- cat_typo
condition:
pwd:
- ^/home/commander$
command:
- ^ls ThingsIWillOrganizeLaterWhenIHaveTime$
responses:
- content: |
你看到了這個資料夾裡有著三個檔案:一個如何做三明治的教學跟兩個在半夜隨機下載的東西。
假如我們要打開三明治教學 `HowToProperlyMakeASandwich.txt`,但是它位在資料夾中,我們沒辦法只按一次 Tab 就補全它的檔名。
這次我們就要來練習使用**連續的自動補全**。
像這樣檔案位在其他資料夾的情況,我們只要先輸入資料夾名稱的開頭,按一次 Tab,再輸入檔案的開頭,再按一次 Tab,就能夠補全 `資料夾/檔名` 了。
而且當你補全的對象是資料夾時,終端機還會自動幫你在結尾加上 `/`,省去你自己輸入的時間。
那麼我們就來打開 `HowToProperlyMakeASandwich.txt`。
hints:
- ➤ 輸入 `cat ThingsIWillOrganizeLaterWhenIHaveTime/HowToProperlyMakeASandwich.txt` 來印出檔案內容
- ➤ 先輸入 `cat Thin` 按 Tab 補全至 `cat ThingsIWillOrganizeLaterWhenIHaveTime/`
- ➤ 再輸入 `cat ThingsIWillOrganizeLaterWhenIHaveTime/How` 按 Tab 補全至完整路徑
- id: cat_sandwich
task: 使用 `cat` 印出 ThingsIWillOrganizeLaterWhenIHaveTime/HowToProperlyMakeASandwich.txt 的內容
requirements:
- ls_things
condition:
command:
- ^cat ThingsIWillOrganizeLaterWhenIHaveTime/HowToProperlyMakeASandwich.txt$
responses:
- content: |
你看到了這份嚴謹的三明治製作教學。
那我們剩下來要看的就是資料夾裡的兩個檔案:`RandomStuffThatIDownloadedAt3AM.txt` 和 `RandomStuffThatIDownloadedAt4AM.txt`
兩個檔名非常相似,只有最後一個是 3AM 另一個是 4AM。
這樣我們只打前面幾個字的時候,沒有辦法分辦到底選的是哪一個檔案。
這就是**發生衝突**。
遇到衝突的解決方法,其實跟使用資料夾是一樣的。
在輸入 `Ran` 按下 Tab 後,終端機會補全到衝突發生前的位置,也就是 `RandomStuffThatIDownloadedAt`。
我們只要根據我們想開啟的檔案,輸入 `3` 或是 `4`,再按一下 Tab,就能夠補全剩下的檔名了。
_如果我們把完整的路徑視作補全的對象,那資料夾其實就是一種衝突的情況。_
hints:
- ➤ 印出 `ThingsIWillOrganizeLaterWhenIHaveTime/RandomStuffThatIDownloadedAt3AM.txt` 的檔案內容
- ➤ 先輸入 `cat Thin` 按 Tab 補全至 `cat ThingsIWillOrganizeLaterWhenIHaveTime/`
- ➤ 再接續輸入 `Ran` 按 Tab 補全至 `cat ThingsIWillOrganizeLaterWhenIHaveTime/RandomStuffThatIDownloadedAt`
- ➤ 再接續輸入 `3` 後按 Tab 補全至完整的路徑。
- id: cat_3am
task: 使用 `cat` 印出 ThingsIWillOrganizeLaterWhenIHaveTime/RandomStuffThatIDownloadedAt3AM.txt 的內容
requirements:
- cat_sandwich
condition:
pwd:
- ^/home/commander$
command:
- ^cat ThingsIWillOrganizeLaterWhenIHaveTime/RandomStuffThatIDownloadedAt3AM.txt$
responses:
- content: |
你看到了一份凌晨三點下載的檔案列表。嗯…我今天網路用的夠多了。
最後留下一個挑戰給你,請先進入到 `ThingsIWillOrganizeLaterWhenIHaveTime` 資料夾後,再印出 `RandomStuffThatIDownloadedAt4AM.txt`。
練習使用今天教的自動補全來完成任務。
hints:
- ➤ 先使用 `cd` 進入 ThingsIWillOrganizeLaterWhenIHaveTime 資料夾
- ➤ 再使用 `cat` 印出 RandomStuffThatIDownloadedAt4AM.txt 的內容
- ➤ 記得使用 Tab 自動補全來節省時間和避免錯誤
- id: cd_things
task: 使用 `cd` 進入 ThingsIWillOrganizeLaterWhenIHaveTime 資料夾
requirements:
- cat_3am
condition:
pwd:
- ^/home/commander/ThingsIWillOrganizeLaterWhenIHaveTime$
responses:
- content: |
很好,你已經成功進入 ThingsIWillOrganizeLaterWhenIHaveTime 資料夾了。
現在請使用 `cat` 指令來印出 `RandomStuffThatIDownloadedAt4AM.txt` 的內容。
記得運用 Tab 自動補全功能!
- id: END
task: 使用 `cat` 印出 RandomStuffThatIDownloadedAt4AM.txt 的內容
requirements:
- cd_things
condition:
pwd:
- ^/home/commander/ThingsIWillOrganizeLaterWhenIHaveTime$
command:
- ^cat RandomStuffThatIDownloadedAt4AM.txt$
responses:
- content: |
恭喜你!你已經成功完成了所有的任務,並且熟練地運用了 Tab 自動補全功能。
這個技能將會在你未來的終端機操作中帶來極大的便利。
記住,不論是長檔名、複雜路徑,還是難以拼寫的檔案名稱,Tab 自動補全都是你的好幫手!
hints:
- ➤ 你已經完成了所有任務!可以繼續探索或是結束這個關卡。
@@ -0,0 +1,10 @@
1. 收集全世界的襪子,讓所有人都找不到另一支襪子。
2. 訓練一支企鵝軍隊,用可愛征服世界。
3. 發明一種能讓所有人講話都變成雞叫聲的裝置。
4. 把所有的咖啡替換成無咖啡因的,看著世界陷入混亂。
5. 用巨大的橡皮擦擦掉所有國家的邊界,宣布地球是一個巨大的遊樂場。
6. 讓所有政治家在演講時必須穿著小丑服裝。
7. 把所有的數學課本改成烹飪食譜,看看會發生什麼。
8. 發明一種能讓人說出真心話的香水,然後在聯合國大會上噴灑。
9. 用巨大的磁鐵吸走地球上所有的金屬,建造一個太空迪士尼樂園。
10. 最後,如果以上都失敗了,就用可愛貓咪影片轟炸全世界的社交媒體,直到所有人都投降為止。
@@ -0,0 +1,9 @@
如何"正確"製作一個三明治:
1. 用力拍醒你的麵包。它們整天都在發懶!
2. 仔細選擇配料,確保每種都有自己的個性。例如,挑選一片特別愛說笑話的火腿。
3. 用尺精確測量每片配料的厚度,誤差不得超過1毫米。
4. 在組裝三明治時,必須戴上白手套和實驗室防護鏡,以確保最高級別的衛生。
5. 完成後,用放大鏡仔細檢查每一寸三明治,確保完美無缺。
記住:製作三明治是一門精確的科學,絕不容許有任何差錯或創意!
@@ -0,0 +1,5 @@
我在凌晨 3 點開始下載的東西,但我一直沒有時間去整理。
1. 一個可以把所有食物變成披薩的魔法棒設計圖
2. 如何在五分鐘內學會十種外星語言的秘密指南
3. 用舊襪子製作時尚帽子的教程視頻(連結已失效)
@@ -0,0 +1,5 @@
我在凌晨 4 點開始下載的東西,但我一直沒有時間去整理。
1. 一份詳細解釋為什麼貓咪才是地球真正統治者的論文
2. 如何用口香糖和迴紋針修理國際太空站的WikiHow頁面
3. 訓練水母成為水下偵探的完整課程大綱
@@ -0,0 +1,3 @@
Congrats! You fond a flie namd by somone who cleerly had a strok. If you can raed this, you mght be a geenius or jsut realy gud at Wheel of Fortnue.
Remeber: freinds don't let freinds name files aftr drinkng too much. But hey, at lest you used tab compltion to get here!
+95
View File
@@ -0,0 +1,95 @@
# 使用 Tab 自動補全
在這個關卡,你將會學到
1. 如何使用 Tab 自動補全路徑
2. 出現衝突時如何處理
按下中間的按鈕來開始這個關卡。
---
在終端機裡,所有的操作都是用文字進行。
然而,打字很花時間,而且只要一個字打錯,指令就會執行失敗。
因此終端機提供「自動補全」的功能,自動幫你完成檔案路徑、指令名稱、參數名稱,節省你的時間,也避免輸入錯誤。
在開始練習之前,我們先來看看家目錄下有哪些檔案。
> 使用 `ls` 查看檔案列表
---
你看到了這個資料夾中充滿了超級長和有錯字的檔案名稱,如果這些都要我們一個一個字輸入,肯定會很痛苦。
但不要緊,只要使用自動補全,檔名不論多長都能輕鬆輸入。
使用自動補全的方法是,**先輸入部分的檔名,再按下 Tab**
(Tab 是 Q 左邊的按鍵)
例如要補全 `SuperSecretPlansForWorldDomination.txt`,你可以先輸入 `Su` 再按下 Tab,終端機就會幫你打完剩下的檔名了。
我們試看看印出 `SuperSecretPlansForWorldDomination.txt` 這個檔案的內容。
> 使用 `cat SuperSecretPlansForWorldDomination.txt` 來印出檔案內容
> 在輸入 `cat Su` 之後按下 Tab 來自動補全檔名,完成後按 Enter 就能執行指令
---
你看到了終端機自動幫你補全了 `SuperSecretPlansForWorldDomination.txt`,就算是很長的檔名,也不用怕打錯字。
開頭不論你打了幾個字都無所謂,你可以只打 `S`、`Su`、`Sup`、`Super` 或甚至完全不打字都沒關係。
但是你打的字越少,就越容易跟其他的檔案重複,這時候就要做衝突處理。
關於衝突處理,我們會在待會練習。
自動補全也可以用來對付拼字錯誤,像是 `ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt` 這個檔案充滿了錯字,任誰來打都難保不會失手。
這一次,請你一樣用 `cat` 來試著印出 `ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt` 的內容。
> 輸入 `cat ThsisAFlieNmaeWthAloOfTpyosThatisRleayHdToRaed.txt` 來印出檔案內容
> 輸入 `cat Thsi` 之後按下 Tab 做自動補全
> 試試看輸入更少的字元就按 Tab 會有什麼樣的結果
---
你看到了這個充滿錯字的檔案了。
只要使用自動補全,不管是錯字、大小寫變化、還是隨機亂碼都不再是困擾了。
讓我們再練習一個,這次請你查看 `ThingsIWillOrganizeLaterWhenIHaveTime` 資料夾中的檔案。
一樣,輸入前幾個字,然後按 Tab 自動補全。
> 輸入 `ls ThingsIWillOrganizeLaterWhenIHaveTime` 查看資料夾中的檔案
> 輸入 `ls Thing` 之後按下 Tab 做自動補全
---
你看到了這個資料夾裡有著三個檔案:一個如何做三明治的教學跟兩個在半夜隨機下載的東西。
假如我們要打開三明治教學 `HowToProperlyMakeASandwich.txt`,但是它位在資料夾中,我們沒辦法只按一次 Tab 就補全它的檔名。
這次我們就要來練習使用**連續的自動補全**。
像這樣檔案位在其他資料夾的情況,我們只要先輸入資料夾名稱的開頭,按一次 Tab,再輸入檔案的開頭,再按一次 Tab,就能夠補全 `資料夾/檔名` 了。
而且當你補全的對象是資料夾時,終端機還會自動幫你在結尾加上 `/`,省去你自己輸入的時間。
那麼我們就來打開 `HowToProperlyMakeASandwich.txt`。
> 輸入 `cat ThingsIWillOrganizeLaterWhenIHaveTime/HowToProperlyMakeASandwich.txt` 來印出檔案內容
> 先輸入 `cat Thin` 按 Tab 補全至 `cat ThingsIWillOrganizeLaterWhenIHaveTime/`
> 再輸入 `cat ThingsIWillOrganizeLaterWhenIHaveTime/How` 按 Tab 補全至完整路徑
---
你看到了這份嚴謹的三明治製作教學。
那我們剩下來要看的就是資料夾裡的兩個檔案:`RandomStuffThatIDownloadedAt3AM.txt` 和 `RandomStuffThatIDownloadedAt4AM.txt`
兩個檔名非常相似,只有最後一個是 3AM 另一個是 4AM。
這樣我們只打前面幾個字的時候,沒有辦法分辦到底選的是哪一個檔案。
這就是**發生衝突**。
遇到衝突的解決方法,其實跟使用資料夾是一樣的。
在輸入 `Ran` 按下 Tab 後,終端機會補全到衝突發生前的位置,也就是 `RandomStuffThatIDownloadedAt`。
我們只要根據我們想開啟的檔案,輸入 `3` 或是 `4`,再按一下 Tab,就能夠補全剩下的檔名了。
_如果我們把完整的路徑視作補全的對象,那資料夾其實就是一種衝突的情況。_
> 輸入 `cat ThingsIWillOrganizeLaterWhenIHaveTime/RandomStuffThatIDownloadedAt3AM.txt` 來印出檔案內容
> 先輸入 `cat Thin` 按 Tab 補全至 `cat ThingsIWillOrganizeLaterWhenIHaveTime/`
> 再接續輸入 `Ran` 按 Tab 補全至 `cat ThingsIWillOrganizeLaterWhenIHaveTime/RandomStuffThatIDownloadedAt`
> 再接續輸入 `3` 後按 Tab 補全至完整的路徑。
---
你看到了一份凌晨三點下載的檔案列表。嗯…我今天網路用的夠多了。
最後留下一個挑戰給你,請先進入到 `ThingsIWillOrganizeLaterWhenIHaveTime` 資料夾後,再印出 `RandomStuffThatIDownloadedAt4AM.txt`。
練習使用今天教的自動補全來完成任務。
+2
View File
@@ -40,6 +40,7 @@
"passport-jwt": "^4.0.1",
"passport-local": "^1.0.0",
"socket.io": "^4.7.1",
"ssh2": "^1.16.0",
"swagger-ui-express": "^5.0.0",
"validator": "^13.11.0",
"winston": "^3.11.0",
@@ -61,6 +62,7 @@
"@types/passport-local": "^1.0.38",
"@types/passport-oauth2": "^1.4.15",
"@types/source-map-support": "^0",
"@types/ssh2": "^1.15.1",
"@types/swagger-ui-express": "^4.1.6",
"@types/validator": "^13.11.9",
"concurrently": "^8.2.2",
@@ -43,7 +43,10 @@ export const createSession = asyncHandler(
async (req: Request, res: Response) => {
const { questId } = matchedData(req)
const user = await User.findById((req.user as Express.ExistingUser).id)
if (user && (await isQuestUnlocked(user, questId))) {
if (
user &&
((await isQuestUnlocked(user, questId)) || config.testing.enabled)
) {
const session = await createNewSession(user, questId)
res.status(201).json(sessionDetail(session))
} else {
+14 -9
View File
@@ -1,8 +1,9 @@
import { Server } from 'socket.io'
import type { Socket } from 'socket.io'
import { Duplex } from 'stream'
import validator from 'validator'
import type { Server as HttpServer } from 'http'
import { Session } from '@linux-odyssey/models'
import { ISession, Session } from '@linux-odyssey/models'
import { getAndStartContainer, attachContainer } from '../containers/docker.js'
import SessionMiddleware from '../middleware/session.js'
import { genJWT } from '../utils/auth.js'
@@ -77,30 +78,34 @@ async function connectContainer(socket: Socket, next: (err?: Error) => void) {
stream,
}
next()
} catch {
next(new Error('Failed to start container.'))
} catch (err) {
logger.error(err)
next(new Error('Failed to connect to container.'))
}
}
function onConnect(socket: Socket) {
const { session, stream } = socket.data.context
stream.socket.on('data', (chunk: Buffer) => {
const { session, stream } = socket.data.context as {
session: ISession
stream: Duplex
}
stream.on('data', (chunk: Buffer) => {
socket.emit('terminal', chunk.toString())
})
socket.on('terminal', function incoming(message) {
stream.socket.write(message)
stream.write(message)
})
const socketCallback = (event: string, ...data: any[]) => {
socket.emit(event, ...data)
}
listenToSession(session.id, socketCallback)
listenToSession(session._id.toString(), socketCallback)
socket.on('disconnect', () => {
stream.socket.write('exit\n')
removeFromSession(session.id, socketCallback)
stream.write('exit\n')
removeFromSession(session._id.toString(), socketCallback)
stream.destroy()
})
}
+31 -8
View File
@@ -1,6 +1,9 @@
import validator from 'validator'
import dotenv from 'dotenv'
import { fileURLToPath } from 'node:url'
import path from 'path'
import { get } from './utils/env.js'
import { loadOrCreateKeyPair } from './utils/crypto.js'
// Import dotenv and load ../.env
dotenv.config({ path: '../.env' })
@@ -29,22 +32,31 @@ function getUrl(key: string): string {
function createConfig() {
const isProduction = process.env.NODE_ENV === 'production'
const host = get('HOST', 'localhost')
const host = get('HOST', '0.0.0.0')
const port = Number(get('PORT', 3000))
const baseUrl = get('BASE_URL', `http://${host}:${port}`)
const backendUrl = get('BACKEND_URL', `http://host.docker.internal:${port}`)
const url = new URL(baseUrl)
const projectRoot = getProjectRoot()
const keypairPath = get(
'KEYPAIR_PATH',
path.join(projectRoot, 'config', 'ssh_key')
)
const keypair = loadOrCreateKeyPair(keypairPath)
return {
host,
port,
baseUrl,
domain: url.hostname,
protocol: url.protocol,
backendUrl: get('BACKEND_URL', baseUrl),
backendUrl,
db: get('MONGO_URL', 'mongodb://localhost:27017/odyssey-test'),
secret: get('SECRET_KEY', ''),
isProduction: process.env.NODE_ENV === 'production',
containerExpiry: get('EXPIRY', 1000 * 60 * 60),
sessionMaxAge: get('SESSION_MAX_AGE', 1000 * 60 * 60 * 24 * 7),
containerExpiry: Number(process.env.CONTAINER_EXPIRY ?? 60) * 1000 * 60,
sessionMaxAge:
Number(process.env.SESSION_MAX_AGE ?? 7 * 24) * 1000 * 60 * 60,
google: {
clientID: get('GOOGLE_CLIENT_ID', ''),
clientSecret: get('GOOGLE_CLIENT_SECRET', ''),
@@ -57,16 +69,20 @@ function createConfig() {
surveyUrl: getUrl('SURVEY_URL'),
bugReportUrl: getUrl('BUG_REPORT_URL'),
projectRoot,
docker: {
network: get('DOCKER_NETWORK', 'host'),
network: get('DOCKER_NETWORK', 'linux-odyssey-players-dev'),
defaultImage: get('QUEST_IMAGE', 'linuxodyssey/quest-base'),
imagePrefix: get('DOCKER_PREFIX', 'linuxodyssey/quest-'),
mountQuest: get('MOUNT_QUEST', ''),
hostPwd: get('HOST_PWD', ''),
mountQuest: process.env.MOUNT_QUEST === 'true',
hostProjectRoot: get('HOST_PROJECT_ROOT', projectRoot),
keypairPath,
keypair,
},
log: {
path: get('LOG_PATH', '../logs'),
path: get('LOG_PATH', path.join(projectRoot, 'logs')),
},
testing: {
enabled: !isProduction && process.env.TESTING === 'true',
@@ -76,9 +92,16 @@ function createConfig() {
}
}
function getProjectRoot(): string {
const filename = fileURLToPath(import.meta.url)
const root = path.join(path.dirname(filename), '..', '..')
return root
}
const config = createConfig()
export function getQuestImage(id: string): string {
// TODO: handle staging images (add version tag)
return `${config.docker.imagePrefix}${id}`
}
+75 -39
View File
@@ -1,41 +1,77 @@
import fs from 'fs/promises'
import { Duplex } from 'stream'
import Docker from 'dockerode'
import config, { getQuestImage } from '../config.js'
import logger from '../utils/logger.js'
import { connectToSSH } from './ssh.js'
const engine = new Docker()
const containerOptions = {
AttachStdin: true,
AttachStdout: true,
AttachStderr: true,
Tty: true,
OpenStdin: true,
StdinOnce: false,
const newContainerOptions = (
name: string,
imageId: string,
options: {
binds?: string[]
} = {}
): Docker.ContainerCreateOptions => ({
name,
Image: getQuestImage(imageId),
HostConfig: {
NetworkMode: config.docker.network,
Binds: options.binds,
ExtraHosts: ['host.docker.internal:host-gateway'],
},
} as Docker.ContainerCreateOptions
ExposedPorts: {
'22/tcp': {},
},
Env: [`PUB_KEY=${config.docker.keypair.publicKey}`],
})
export function createContainer(
export async function createContainer(
name: string,
questId: string
questId: string,
imageId: string
): Promise<Docker.Container> {
const option = {
...containerOptions,
name,
Image: getQuestImage(questId),
let binds: string[] = []
if (await questHomeExists(questId)) {
logger.info('Mounting quest home', questId)
binds.push(
`${config.docker.hostProjectRoot}/quests/${questId}/home:/etc/skel:ro`
)
}
const { hostPwd, mountQuest } = config.docker
if (!config.isProduction && hostPwd && mountQuest === questId) {
logger.info('Mounting quest folder', mountQuest)
option.HostConfig!.Binds = [
`${hostPwd}/quests/${mountQuest}/home:/home/commander`,
`${hostPwd}/packages/container:/usr/local/lib/container`,
if (!config.isProduction && config.docker.mountQuest && imageId !== 'base') {
logger.info('Mounting quest folder', questId)
binds = [
`${config.docker.hostProjectRoot}/quests/${questId}/home:/home/commander`,
`${config.docker.hostProjectRoot}/packages/container:/usr/local/lib/container`,
]
}
const option = newContainerOptions(name, imageId, { binds })
await createNetworkIfNotExists(config.docker.network)
return engine.createContainer(option)
}
async function createNetworkIfNotExists(network: string) {
const dockerNetworks = await engine.listNetworks({
filters: {
name: [network],
},
})
if (dockerNetworks.length === 0) {
logger.log('Creating player network', network)
await engine.createNetwork({ Name: network })
}
}
async function questHomeExists(imageId: string) {
try {
const stat = await fs.stat(`${config.projectRoot}/quests/${imageId}/home`)
return stat.isDirectory()
} catch {
return false
}
}
export async function getAndStartContainer(
id: string
): Promise<Docker.Container> {
@@ -53,26 +89,26 @@ export async function getAndStartContainer(
export async function attachContainer(
container: Docker.Container,
{ token }: { token: string }
) {
const exec = await container.exec({
AttachStdin: true,
AttachStdout: true,
AttachStderr: true,
Cmd: ['/bin/zsh'],
Tty: true,
Env: [
`TOKEN=${token}`,
`API_ENDPOINT=${config.backendUrl}`,
'ZDOTDIR=/etc/zsh',
],
})
): Promise<Duplex> {
const containerIp = (await container.inspect()).NetworkSettings.Networks[
config.docker.network
].IPAddress
const execOutput = await exec.start({
Detach: false,
Tty: true,
})
return execOutput
let error: Error | null = null
for (let i = 0; i < 10; i++) {
try {
// eslint-disable-next-line no-await-in-loop
const stream = await connectToSSH(containerIp, { token })
return stream
} catch (err) {
error = err as Error
// eslint-disable-next-line no-await-in-loop
await new Promise((resolve) => {
setTimeout(resolve, 1000)
})
}
}
throw new Error('Failed to connect to SSH', { cause: error })
}
export async function deleteContainer(id: string) {
+45
View File
@@ -0,0 +1,45 @@
import { Client } from 'ssh2'
import { Duplex } from 'stream'
import config from '../config.js'
export async function connectToSSH(
containerIp: string,
{ token }: { token: string }
): Promise<Duplex> {
const conn = new Client()
return new Promise((resolve, reject) => {
conn
.on('ready', () => {
conn.shell(
{
env: {
TOKEN: token,
API_ENDPOINT: config.backendUrl,
ZDOTDIR: '/etc/zsh',
NODE_PATH: '/usr/src/node_modules',
},
},
(err, stream) => {
if (err) {
reject(err)
}
stream.on('close', () => {
conn.end()
})
resolve(stream)
}
)
})
.on('error', (err) => {
reject(err)
})
.connect({
host: containerIp,
port: 22,
username: 'commander',
privateKey: config.docker.keypair.privateKey,
timeout: 5000,
})
})
}
+1 -1
View File
@@ -72,7 +72,7 @@ async function main() {
app.use('/api/v1', apiRouter)
app.use(errorHandler)
server.listen(config.port, config.host, () => {
server.listen(config.port, '0.0.0.0', () => {
logger.info(`Server listening at ${config.baseUrl}`)
})
}
+1
View File
@@ -43,6 +43,7 @@ export async function createNewSession(
const container = await createContainer(
`quest-${quest.id}-${user.username}-${Date.now()}`,
quest.id,
quest.image
)
+39
View File
@@ -0,0 +1,39 @@
import fs from 'fs'
import path from 'path'
import ssh2 from 'ssh2'
const {
utils: { generateKeyPairSync },
} = ssh2
type KeyPair = {
privateKey: string
publicKey: string
}
export function loadOrCreateKeyPair(privateKeyPath: string): KeyPair {
const publicKeyPath = `${privateKeyPath}.pub`
if (fs.existsSync(privateKeyPath) && fs.existsSync(publicKeyPath)) {
const privateKey = fs.readFileSync(privateKeyPath, 'utf8')
const publicKey = fs.readFileSync(publicKeyPath, 'utf8')
return { privateKey, publicKey }
}
const dir = path.dirname(privateKeyPath)
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true })
}
const keyPair = generateKeyPair()
fs.writeFileSync(privateKeyPath, keyPair.privateKey, {
mode: 0o600,
})
fs.writeFileSync(publicKeyPath, keyPair.publicKey, {
mode: 0o600,
})
return keyPair
}
export function generateKeyPair(): KeyPair {
const { private: privateKey, public: publicKey } =
generateKeyPairSync('ed25519')
return { privateKey, publicKey }
}
+9
View File
@@ -0,0 +1,9 @@
import { generateKeyPair } from '../../src/utils/crypto'
describe('generateKeyPair', () => {
it('should generate a key pair', () => {
const keyPair = generateKeyPair()
expect(keyPair).toHaveProperty('privateKey')
expect(keyPair).toHaveProperty('publicKey')
})
})
+2585 -1291
View File
File diff suppressed because it is too large. Load diff