-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: remove replica and bootstrap commands (#3220)
This just removes the commands from the command tree and disables the tests. In the next version we can delete them, but I want one release where anyone who still relies on these will have to notice, before deleting the code.
- Loading branch information
1 parent
41dc038
commit 209042d
Showing
9 changed files
with
35 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,4 @@ | ||
# dfx bootstrap {#_dfx_bootstrap} | ||
|
||
> **NOTE**: The bootstrap command is deprecated. Please use the [dfx start](./dfx-start.md) command instead. If you have a good reason to use the bootstrap command, please contribute to the [discussion](https://github.com/dfinity/sdk/discussions/3163). | ||
> **NOTE**: The bootstrap command has been removed. Please use the [dfx start](./dfx-start.md) command instead. If you have a good reason to use the bootstrap command, please contribute to the [discussion](https://github.com/dfinity/sdk/discussions/3163). | ||
Use the `dfx bootstrap` command to start the bootstrap web server defined in the `dfx.json` configuration file or specified using command-line options. | ||
|
||
The bootstrap web server you specify is used to serve the front-end static assets for your project. | ||
|
||
## Basic usage {#_basic_usage} | ||
|
||
``` bash | ||
dfx bootstrap [option] | ||
``` | ||
|
||
## Options {#_options} | ||
|
||
You can specify the following options for the `dfx bootstrap` command. | ||
|
||
| Option | Description | | ||
-----------------------|-----------------| | ||
| `ip` <ip_address\> | Specifies the IP address that the bootstrap server listens on. If you don't specify an IP address, the `address` setting you have configured in the `dfx.json` configuration file is used. By default, the server address is 127.0.0.1. | | ||
| \--network <network\> | Specifies the network to connect to if you want to override the default local network endpoint (`http://127.0.0.1:8080/api`).| | ||
| \--port <port\> | Specifies the port number that the bootstrap server listens on. By default, port number 8081 is used. | | ||
| \--timeout <timeout\> | Specifies the maximum amount of time, in seconds, the bootstrap server will wait for upstream requests to complete. By default, the bootstrap server waits for a maximum of 30 seconds. | | ||
|
||
## Examples {#_examples} | ||
|
||
You can use the `dfx bootstrap` command to start a web server for your application using custom settings, including a specific server address, port number, and static asset location. | ||
|
||
For example, to start the bootstrap server using a specific IP address and port number, you would run a command similar to the following: | ||
|
||
``` bash | ||
dfx bootstrap --ip 192.168.47.1 --port 5353 | ||
``` | ||
|
||
The command displays output similar to the following: | ||
|
||
``` bash | ||
binding to: V4(192.168.47.1:5353) | ||
replica(s): \http://127.0.0.1:8080/api | ||
Webserver started... | ||
``` | ||
|
||
To use the default server address and port number but specify a custom location for static assets and longer timeout period, you might run a command similar to the following: | ||
|
||
``` bash | ||
dfx bootstrap --root $HOME/ic-projects/assets --timeout 60 | ||
``` | ||
|
||
You can use CTRL-C to stop the bootstrap server. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,4 @@ | ||
# dfx replica | ||
|
||
> **NOTE**: The replica command is deprecated. Please use the [dfx start](./dfx-start.md) command instead. If you have a good reason to use the replica command, please contribute to the [discussion](https://github.com/dfinity/sdk/discussions/3163). | ||
> **NOTE**: The replica command has been removed. Please use the [dfx start](./dfx-start.md) command instead. If you have a good reason to use the replica command, please contribute to the [discussion](https://github.com/dfinity/sdk/discussions/3163). | ||
Use the `dfx replica` command to start a local canister execution environment (without a web server). This command enables you to deploy canisters locally and to test your dapps during development. | ||
|
||
By default, all local dfx projects will use a single shared local canister execution environment, and you can run `dfx replica` from any directory. See [Local Server Configuration](#local-server-configuration) and [Project-Specific Local Networks](dfx-start.md#project-specific-local-networks) for exceptions. | ||
|
||
## Basic usage | ||
|
||
``` bash | ||
dfx replica [option] [flag] | ||
``` | ||
|
||
## Flags | ||
|
||
You can use the following optional flags with the `dfx replica` command. | ||
|
||
| Flag | Description | | ||
|-------------------|-----------------------------------------------------------------------------------------------| | ||
| `--emulator` | Starts the [IC reference emulator](https://github.com/dfinity/ic-hs) rather than the replica. | | ||
| `--enable-bitcoin`| Enables bitcoin integration. | | ||
| `--enable-canister-http` | Enables canister HTTP requests. (deprecated: now enabled by default) | | ||
|
||
## Options | ||
|
||
You can use the following option with the `dfx replica` command. | ||
|
||
| Option | Description | | ||
|---------------------------|-------------------------------------------------------------------------------| | ||
| `--port port` | Specifies the port the local canister execution environment should listen to. | | ||
| `--bitcoin-node host:port` | Specifies the address of a bitcoind node. Implies `--enable-bitcoin`. | | ||
| `--artificial-delay milliseconds` | Specifies the delay that an update call should incur. Default: 600ms | | ||
|
||
## Examples | ||
|
||
You can start the local canister execution environment by running the following command: | ||
|
||
``` bash | ||
dfx replica | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters