Skip to content

Commit 110935b

Browse files
docs: make the guides CLI-only, drop every Console mention
1 parent faad0bb commit 110935b

3 files changed

Lines changed: 29 additions & 32 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See `requirements/*.md` for the full behavioural spec (`system.md`, `api.md`,
1414
## Documentation
1515

1616
- [Quick start](docs/quick-start.md) - start the runtime with Apify CLI or Docker, connect the CLI,
17-
push and run an Actor, view the results, and the proposed `apify local` commands.
17+
push and run your Actor, view the results, and the proposed `apify local` commands.
1818
- [Local development workflow](docs/local-development.md) - build, run, view results, iterate without
1919
rebuilding, debug with your IDE, test platform events, simulate users, fall back to the platform,
2020
limitations, and proposed improvements.

docs/local-development.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,7 @@ To use Apify Proxy from local runs, set `APIFY_PROXY_PASSWORD` on the runtime co
7373

7474
## View the results
7575

76-
Everything a run produced is available in three places.
77-
78-
### Console
79-
80-
Open [http://localhost:3000](http://localhost:3000). The Console lists Actors, builds, runs, logs, and storages. A run's detail page links to its default storages, and log views render ANSI colours. The Console accepts the URL shapes Apify CLI prints for the Apify Console, so links in `apify call` output open the right page.
76+
Everything a run produced is available in two places.
8177

8278
### CLI
8379

@@ -117,7 +113,7 @@ For Actors with a slow build, such as browser images or heavy Python installs, t
117113
apify call --input '{"maxPages": 3}'
118114
```
119115
120-
To clear the registration, submit an empty body: `--body '""'`. The same field is on the Actor's page in the Console.
116+
To clear the registration, submit an empty body: `--body '""'`.
121117
122118
**How the mount behaves**
123119
@@ -160,13 +156,13 @@ apify api POST /actor-runtime/debug/<actorId> --body '{"enabled": false}'
160156
161157
The platform stops, migrates, and aborts Actors. You can trigger these events against a `RUNNING` run to check that your Actor persists its state and resumes correctly.
162158
163-
| Event | How to trigger | What the Actor sees |
164-
| -------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
165-
| Migration | `apify api POST /actor-runtime/migrate/<runId>`, or the **Migrate** button on the run's Console page | A `migrating` event, then its container stops about five seconds later and a new container starts for the same run with the same id, environment, and storages. In-memory state is gone. The status stays `RUNNING`. |
166-
| Reboot | `apify api POST v2/actor-runs/<runId>/reboot` | An immediate stop and restart with no warning event. The SDKs call this from their default migration handler. |
167-
| Graceful abort | `apify api POST 'v2/actor-runs/<runId>/abort?gracefully=true'` | `aborting` and `persistState` events, then the container stops 30 seconds later. |
168-
| Abort | `apify api POST v2/actor-runs/<runId>/abort` | The container stops at once. |
169-
| Timeout | `apify call --timeout 10` | The run ends as `TIMED-OUT` when the deadline passes. The budget is per run, so a migrated run gets only the remaining time. |
159+
| Event | How to trigger | What the Actor sees |
160+
| -------------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
161+
| Migration | `apify api POST /actor-runtime/migrate/<runId>` | A `migrating` event, then its container stops about five seconds later and a new container starts for the same run with the same id, environment, and storages. In-memory state is gone. The status stays `RUNNING`. |
162+
| Reboot | `apify api POST v2/actor-runs/<runId>/reboot` | An immediate stop and restart with no warning event. The SDKs call this from their default migration handler. |
163+
| Graceful abort | `apify api POST 'v2/actor-runs/<runId>/abort?gracefully=true'` | `aborting` and `persistState` events, then the container stops 30 seconds later. |
164+
| Abort | `apify api POST v2/actor-runs/<runId>/abort` | The container stops at once. |
165+
| Timeout | `apify call --timeout 10` | The run ends as `TIMED-OUT` when the deadline passes. The budget is per run, so a migrated run gets only the remaining time. |
170166
171167
The run log is cumulative across restarts, with a marker line between container incarnations.
172168
@@ -178,8 +174,6 @@ Each distinct token gets its own user, and API responses are scoped to that user
178174
apify api v2/datasets -H '{"authorization": "Bearer another-token"}'
179175
```
180176
181-
The Console has no login and shows every user's objects with their owner, which helps you verify that scoping works.
182-
183177
## Fall back to the Apify platform
184178
185179
If a call fails because the runtime does not have that Actor, run, or storage id, or does not implement the endpoint, you can have such calls relayed to the Apify platform:
@@ -189,7 +183,7 @@ apify api POST /actor-runtime/api-fallback --body '{"fallbackUnimplementedEnable
189183
apify api GET /actor-runtime/api-fallback
190184
```
191185
192-
Both toggles are off by default and reset on every restart. The same toggles are on the Console's Settings page. Relayed responses carry the `x-actor-runtime-fallback` and `x-actor-runtime-fallback-trigger` headers so you can tell where an answer came from.
186+
Both toggles are off by default and reset on every restart. Relayed responses carry the `x-actor-runtime-fallback` and `x-actor-runtime-fallback-trigger` headers so you can tell where an answer came from.
193187
194188
**Use a token you trust with real writes**
195189
@@ -210,13 +204,13 @@ The runtime is a development tool for one developer: fewer than ten Actors, five
210204
- **Not implemented:** Actor tasks, schedules, webhooks, and most of the API outside Actors, builds, runs, logs, and the three storage types. Unknown endpoints return `404` unless [fallback](#fall-back-to-the-apify-platform) is on.
211205
- **Request queues:** locks do not expire, so `head/lock` hands a request out until an explicit unlock, reclaim, or runtime restart. Request deletion returns `501`. `GET /requests` lists only requests this runtime process has seen and ignores filters. Counts on the queue object are authoritative.
212206
- **Storage metadata:** `hadMultipleClients` is always `false`, `stats` fields are zero, and dataset item options such as `fields` or `clean` apply after paging, so `total` counts unfiltered items.
213-
- **Users:** any non-empty token is accepted. There is no real authentication, and the Console shows every user's objects.
207+
- **Users:** any non-empty token is accepted. There is no real authentication.
214208
- **One runtime per data directory.** Do not start two runtimes on the same `data` directory.
215209
- **Operating systems:** Linux is tested. macOS works with the networking note in the [quick start](quick-start.md#start-with-docker). Windows with Docker Desktop and WSL 2 is untested.
216210
217211
## Next steps
218212
219-
- Read the exact behaviour in `requirements/api.md`, `requirements/actor-driver.md`, `requirements/storage.md`, and `requirements/console.md`.
213+
- Read the exact behaviour in `requirements/api.md`, `requirements/actor-driver.md`, and `requirements/storage.md`.
220214
- When your Actor works locally, unset the environment variables and `apify push` to deploy it to the Apify platform.
221215
222216
## Proposed improvements

docs/quick-start.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Add `-d` to run the container in the background. Stop it with `docker stop actor
5252

5353
**Docker Desktop on macOS**
5454

55-
On some Docker Desktop installations, `localhost:3333` and `localhost:3000` time out even though the runtime is healthy. The runtime joins a second Docker network, `apify-local`, so Actor containers can reach it, and Docker Desktop then routes replies through the wrong network. Start the container on that network directly so it has only one:
55+
On some Docker Desktop installations, requests to the runtime's ports time out even though the runtime is healthy. The runtime joins a second Docker network, `apify-local`, so Actor containers can reach it, and Docker Desktop then routes replies through the wrong network. Start the container on that network directly so it has only one:
5656

5757
```
5858
docker network create apify-local 2>/dev/null || true
@@ -74,7 +74,7 @@ To verify that the runtime is up, run:
7474
apify local status
7575
```
7676

77-
The command reports the API at `http://localhost:3333`, the Console at `http://localhost:3000`, and the data directory, and exits non-zero when the runtime is down.
77+
The command reports the runtime API URL, `http://localhost:3333`, and the data directory, and exits non-zero when the runtime is down.
7878

7979
**Proposed command**
8080

@@ -84,7 +84,7 @@ The command reports the API at `http://localhost:3333`, the Console at `http://l
8484
APIFY_CLIENT_BASE_URL=http://localhost:3333 apify api v2/users/me
8585
```
8686

87-
It prints your user as JSON when the runtime is up, and a connection error when it is not. You can also open [http://localhost:3000](http://localhost:3000) in your browser.
87+
It prints your user as JSON when the runtime is up, and a connection error when it is not.
8888

8989
## 2. Connect Apify CLI
9090

@@ -141,19 +141,22 @@ Create one with [`apify create`](https://docs.apify.com/cli/docs/quick-start), o
141141
142142
## 4. View the results
143143
144-
Open [http://localhost:3000](http://localhost:3000) to browse the Actor, its builds and runs, logs, and the dataset, key-value store, and request queue the run produced.
144+
To list the runs of your Actor, run:
145145
146-
You can also use the CLI:
146+
```
147+
apify runs ls
148+
```
149+
150+
To read what a run produced, use the ids `apify call` printed:
147151
148-
| Command | Shows |
149-
| -------------------------------------------------------- | --------------------------------------- |
150-
| `apify runs ls` | Runs of the Actor in the current folder |
151-
| `apify datasets info <datasetId>` | Dataset metadata, including item count |
152-
| `apify api v2/datasets/<datasetId>/items` | Dataset items |
153-
| `apify api v2/key-value-stores/<storeId>/records/OUTPUT` | One key-value store record |
154-
| `apify api v2/actor-runs/<runId>/log` | The run log |
152+
| Command | Shows |
153+
| -------------------------------------------------------- | -------------------------------------- |
154+
| `apify datasets info <datasetId>` | Dataset metadata, including item count |
155+
| `apify api v2/datasets/<datasetId>/items` | Dataset items |
156+
| `apify api v2/key-value-stores/<storeId>/records/OUTPUT` | One key-value store record |
157+
| `apify api v2/actor-runs/<runId>/log` | The run log |
155158
156-
`apify api` sends any request to the runtime API, so everything the Console shows is available this way. The raw files are in the `data` directory. Read them freely, but change state through the API.
159+
`apify api` sends any request to the runtime API, so every Actor, build, run, log, and storage is available this way. The raw files are in the `data` directory. Read them freely, but change state through the API.
157160
158161
## 5. Stop and reset the runtime
159162

0 commit comments

Comments
 (0)