diff --git a/bin/darkirc/README.md b/bin/darkirc/README.md index 484053cc0..685edc2e9 100644 --- a/bin/darkirc/README.md +++ b/bin/darkirc/README.md @@ -1,10 +1,8 @@ darkirc ======= -If you're trying to join the chat, then for now, use the older ircd, -[Installation Guide](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html). - -DarkIRC is still pending a few more upgrades before we switch over. +Check the [Installation Guide](https://darkrenaissance.github.io/darkfi/misc/darkirc/darkirc.html) +for more detailed information about the ins and outs of darkirc. ## Android build diff --git a/contrib/localnet/fud/lilith_config.toml b/contrib/localnet/fud/lilith_config.toml index 756c1d544..1dcd0d482 100644 --- a/contrib/localnet/fud/lilith_config.toml +++ b/contrib/localnet/fud/lilith_config.toml @@ -30,7 +30,7 @@ hosts_file="lilith_hosts.tsv" #localnet = true #channel_log = true -#[network."ircd"] +#[network."darkirc"] #port = 25551 #seeds = [] #peers = [] diff --git a/contrib/runit-init/README.md b/contrib/runit-init/README.md index 7cde6841d..fc826b060 100644 --- a/contrib/runit-init/README.md +++ b/contrib/runit-init/README.md @@ -2,7 +2,7 @@ Startup services for runit. # Make DarkFi Binaries Available -Compile `ircd`, `taud`, and `darkirc`. Make sure they are findable in your path. +Compile `taud` and `darkirc`. Make sure they are findable in your path. You can copy the binaries to `~/.local/bin/`. # Configure Per-User Services and Logging @@ -35,14 +35,13 @@ Finally make sure your user level service is running: Copy the directories here over to `~/.local/sv/`: ```bash - $ cp -r darkirc/ ircd/ taud/ ~/.local/sv/ + $ cp -r darkirc/ taud/ ~/.local/sv/ ``` Activate them by symlinking them into `~/.local/service/`. We need the full path. ```bash $ cd ~/.local/service/ $ ln -s /home/USER/.local/sv/darkirc/ . - $ ln -s /home/USER/.local/sv/ircd/ . $ ln -s /home/USER/.local/sv/taud/ . ``` diff --git a/doc/generate_seminar_ics.py b/doc/generate_seminar_ics.py index 3ad20c400..47ae06b21 100755 --- a/doc/generate_seminar_ics.py +++ b/doc/generate_seminar_ics.py @@ -97,7 +97,7 @@ def print_table(): print("[therapy](https://github.com/narodnik/therapy) that we made.") print("The canvas will also be shared on Jitsi calls.\n") print("Videos will be uploaded online and linked here.") - print("Join [our chat](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html)") + print("Join [our chat](https://darkrenaissance.github.io/darkfi/misc/darkirc/darkirc.html)") print("for more info. Links and text chat will happen there during the calls.") diff --git a/doc/src/arch/overview.md b/doc/src/arch/overview.md index 5b0e89806..2b0b3fec5 100644 --- a/doc/src/arch/overview.md +++ b/doc/src/arch/overview.md @@ -18,7 +18,7 @@ blockchain. All contract execution is done locally on the DarkFi wallet. **P2P Network:** The DarkFi ecosystem runs as a network of P2P nodes, where these nodes interact with each other over specific protocols (see [node overview](dna.md)). Nodes communicate on a peer-to-peer network, -which is also home to tools such as our P2P [irc](../misc/ircd.md) +which is also home to tools such as our P2P [irc](../misc/darkirc.md) and P2P task manager [tau](../misc/tau.md). **ZK smart contracts:** Anonymous applications on DarkFi run on proofs diff --git a/doc/src/clients/nym_outbound.md b/doc/src/clients/nym_outbound.md index a9e8c3afd..76b04c653 100644 --- a/doc/src/clients/nym_outbound.md +++ b/doc/src/clients/nym_outbound.md @@ -94,9 +94,9 @@ can connect to peers manually, or through seed. peers and the seed itself. -## 4. **Setup `ircd`** +## 4. **Setup `darkirc`** -After compiling `ircd`, run it once to spawn the config file. Then +After compiling `darkirc`, run it once to spawn the config file. Then edit it to contain the following: ```toml @@ -117,7 +117,7 @@ outbound_transports = ["nym"] > The most important part that could easily be forgotten is: ```outbound_transports = ["nym"]``` -Now when you start `ircd`, you will be able to discover or connect +Now when you start `darkirc`, you will be able to discover or connect directly to peers and your traffic will be routed through the mixnet. These instructions are also applicable to other nodes in the DarkFi diff --git a/doc/src/clients/tor_inbound.md b/doc/src/clients/tor_inbound.md index 71e5ffc18..afb568018 100644 --- a/doc/src/clients/tor_inbound.md +++ b/doc/src/clients/tor_inbound.md @@ -20,11 +20,11 @@ on an `apt` based system we can run: ``` This will install it. Now in `/etc/tor/torrc` we can set up the hidden -service. For hosting an anonymous `ircd` node, set up the following +service. For hosting an anonymous `darkirc` node, set up the following lines in the file: ``` -HiddenServiceDir /var/lib/tor/darkfi_ircd +HiddenServiceDir /var/lib/tor/darkfi_darkirc HiddenServicePort 25551 127.0.0.1:25551 ``` @@ -37,15 +37,15 @@ Then restart Tor: You can grab the hostname of your hidden service from the directory: ``` -# cat /var/lib/tor/darkfi_ircd/hostname +# cat /var/lib/tor/darkfi_darkirc/hostname ``` For example purposes, let's assume it's `jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion`. -## 2. **Setup `ircd`** +## 2. **Setup `darkirc`** -After compiling `ircd`, run it once to spawn the config file. Then +After compiling `darkirc`, run it once to spawn the config file. Then edit it to contain the following: ```toml @@ -53,7 +53,7 @@ inbound = ["tcp://127.0.0.1:25551"] external_addr = ["tor://jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion:25551"] ``` -Now when you start `ircd`, the hidden service will be announced as +Now when you start `darkirc`, the hidden service will be announced as a peer and people will be able to connect to it when they discover you as a peer. diff --git a/doc/src/dev/contrib/contrib.md b/doc/src/dev/contrib/contrib.md index 533b06524..3dcd8d060 100644 --- a/doc/src/dev/contrib/contrib.md +++ b/doc/src/dev/contrib/contrib.md @@ -7,7 +7,7 @@ tooling, Python bindings, p2p apps like the DHT. Every monday 16:00 CET, there is our main dev meeting on -[our chat](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html). +[our chat](https://darkrenaissance.github.io/darkfi/misc/darkirc/darkirc.html). Feel free to join and discuss with other darkfi devs. In general, the best way to get started is to explore the codebase thoroughly and @@ -43,7 +43,7 @@ more than minor cosmetic changes. It also is useful to have online repositories containing your work. We don't care about degrees or qualifications - many of the best coders don't have any. -Secondly you need to get on [our online chat](misc/ircd/ircd.md) and +Secondly you need to get on [our online chat](misc/darkirc/darkirc.md) and make yourself known. We are not spending time on social media or proprietary chats like Telegram because we're very busy. diff --git a/doc/src/misc/darkirc/private_message.md b/doc/src/misc/darkirc/private_message.md index 192961253..4b664ab3b 100644 --- a/doc/src/misc/darkirc/private_message.md +++ b/doc/src/misc/darkirc/private_message.md @@ -1,39 +1,39 @@ # Configuring a Private chat between users -Any two users on the `ircd` server can establish a fully encrypted +Any two users on the `darkirc` server can establish a fully encrypted communication medium between each other using a basic keypair setup. -## Configuring ircd_config.toml +## Configuring darkirc_config.toml -`ircd_config.toml` should be created by default in `~/.config/darkfi/` -when you first run `ircd`. +`darkirc_config.toml` should be created by default in `~/.config/darkfi/` +when you first run `darkirc`. Generate a keypair using the following command: ```shell -% ircd --gen-keypair +% darkirc --gen-keypair ``` This will generate a Public Key and a Private Key. -Save the Private key safely & add it to the `ircd_config.toml` file as shown below. +Save the Private key safely & add it to the `darkirc_config.toml` file as shown below. ```toml [private_key.”your_private_key_goes_here”] ``` -To share your Public Key with a user over `ircd` you can use one of the +To share your Public Key with a user over `darkirc` you can use one of the public channels or via an external app like Signal, as plaintext DMs -are disabled in `ircd`. +are disabled in `darkirc`. -Note: If you use the `ircd`'s public channel, your +Note: If you use the `darkirc`'s public channel, your message will be publically visible on the IRC chat. -See the [example ircd_config.toml](https://github.com/darkrenaissance/darkfi/blob/v0.4.1/bin/ircd/ircd_config.toml) for more details +See the [example darkirc_config.toml](https://codeberg.org/darkrenaissance/darkfi/src/branch/master/bin/darkirc/darkirc_config.toml) for more details ## Example Lets start by configuring our contacts list in the generated -`ircd_config.toml` file (you can also refer to the examples written +`darkirc_config.toml` file (you can also refer to the examples written in the comments of the toml file), let's assume alice and bob want to privately chat after they have each other's public keys: @@ -82,8 +82,8 @@ be anything you want, and you should use it when DMing. Note: It's always a good idea to save your keys somewhere safe, but in case you lost your Public Key and you still have your Private key in -`ircd_config.toml` file, you recover the Public Key like so: +`darkirc_config.toml` file, you recover the Public Key like so: ```shell -% ircd --recover-pubkey {your_private_key} +% darkirc --recover-pubkey {your_private_key} ``` diff --git a/doc/src/misc/dnetview.md b/doc/src/misc/dnetview.md index b3b1b4ce5..2f3b9b1be 100644 --- a/doc/src/misc/dnetview.md +++ b/doc/src/misc/dnetview.md @@ -1,6 +1,6 @@ # Dnetview -A simple tui to explore darkfi ircd network topology. +A simple tui to explore darkfi darkirc network topology. dnetview displays: diff --git a/doc/src/start-here.md b/doc/src/start-here.md index fcd45fd2a..45529634c 100644 --- a/doc/src/start-here.md +++ b/doc/src/start-here.md @@ -37,7 +37,7 @@ which has support for Nym and Tor. Every Monday at 16:00 CET in #dev we have our main project meeting. -See the guide on [darkirc](misc/ircd/ircd.md) for instructions on joining. +See the guide on [darkirc](misc/darkirc/darkirc.md) for instructions on joining. ## Contributing as a Dev