github/darkfi
1
1
Fork 0
mirror of https://github.com/darkrenaissance/darkfi.git synced 2026-01-07 22:04:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc: revert darkirc back to ircd

Browse Source
This commit is contained in:
Dastan-glitch
2023-09-18 19:41:47 +03:00
parent 6c1002a1ba
commit e6e724bccf
5 changed files with 40 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -24,7 +24,7 @@ a Dark Renaissance.
## Connect to DarkFi IRC
Follow the [installation instructions](https://darkrenaissance.github.io/darkfi/misc/darkirc/darkirc.html#installation)
Follow the [installation instructions](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html#installation)
for the P2P IRC daemon.
## Build

6
doc/src/SUMMARY.md
View File

@@ -65,9 +65,9 @@
# Misc
- [vanityaddr](misc/vanityaddr.md)
- [darkirc](misc/darkirc/darkirc.md)
- [Specification](misc/darkirc/specification.md)
- [Private Message](misc/darkirc/private_message.md)
- [ircd](misc/ircd/ircd.md)
- [Specification](misc/ircd/specification.md)
- [Private Message](misc/ircd/private_message.md)
- [tau](misc/tau.md)
- [event_graph](misc/event_graph/event_graph.md)
- [Network Protocol](misc/event_graph/network_protocol.md)

47
doc/src/misc/darkirc/darkirc.md → doc/src/misc/ircd/ircd.md
View File

@@ -1,10 +1,10 @@
# DarkIRC: Strong Anonymity P2P Chat
# ircd: Strong Anonymity P2P Chat
In DarkFi, we organize our communication using resilient and
censorship-resistant infrastructure. For chatting, `darkirc` is a
censorship-resistant infrastructure. For chatting, `ircd` is a
peer-to-peer implementation of an IRC server in which any user can
participate anonymously using any IRC frontend and by running the
IRC daemon. `darkirc` uses the DarkFi P2P engine to synchronize chats
IRC daemon. `ircd` uses the DarkFi P2P engine to synchronize chats
between hosts.
## Benefits
@@ -27,9 +27,9 @@ Follow the instructions in the
you have all the necessary dependencies.
```shell
% git clone https://github.com/darkrenaissance/darkfi
% cd darkfi
% make darkirc
% git clone https://github.com/darkrenaissance/darkfi.git
% cd darkfi && git checkout v0.4.1
% make ircd
```
## Installation (Android)
@@ -37,8 +37,8 @@ you have all the necessary dependencies.
This is for Android 64 bit (which is most phones).
1. Install Docker
2. Run `cd bin/darkirc/ && make android`. The resulting file will be called
`darkirc.aarch64-android`. Copy this to your phone.
2. Run `cd bin/ircd/ && make android`. The resulting file will be called
`ircd.aarch64-android`. Copy this to your phone.
3. Install Termux and RevolutionIRC on F-Droid.
4. You can access the phone storage from `/sdcard/` and copy the file
into the Termux home.
@@ -49,41 +49,32 @@ This is for Android 64 bit (which is most phones).
## Usage (DarkFi Network)
Upon compiling `darkirc` as described above, the preconfigured defaults
Upon compiling `ircd` as described above, the preconfigured defaults
will allow you to connect to the network and start chatting with the
rest of the DarkFi community.
First, try to start `darkirc` from your command-line so it can spawn its
First, try to start `ircd` from your command-line so it can spawn its
configuration file in place. The preconfigured defaults will autojoin
you to several default channels one of which is `#dev` where we have
weekly meetings, and where the community is most active and talks
about DarkFi development.
```shell
% ./darkirc
% ./ircd
```
`darkirc` will create a configuration file `darkirc_config.toml` by
`ircd` will create a configuration file `ircd_config.toml` by
default in `~/.config/darkfi/` you can review and potentially edit. It
might be useful if you want to add other channels you want to autojoin
(like `#philosophy` and `#memes`), or if you want to set a shared
secret for some channel in order for it to be encrypted between its
participants.
When done, you can run `darkirc` for the second time in order for it to
When done, you can run `ircd` for the second time in order for it to
connect to the network and start participating in the P2P protocol:
```shell
% ./darkirc
```
Whenever you edit `darkirc_config.toml` file and if you have your
`darkirc` daemon running you don't need to restart it to reload the
config, you just need to send a SIGHUP signal to it for the changes to
reflect, one of the easiest ways to do that is:
```shell
% kill -SIGHUP $(pidof darkirc)
% ./ircd
```
## Clients
@@ -92,7 +83,7 @@ reflect, one of the easiest ways to do that is:
In this section, we'll briefly cover how to use the [Weechat IRC
client](https://github.com/weechat/weechat) to connect and chat with
`darkirc`.
`ircd`.
Normally, you should be able to install weechat using your
distribution's package manager. If not, have a look at the weechat
@@ -100,9 +91,9 @@ distribution's package manager. If not, have a look at the weechat
on how to install it on your computer.
Once installed, we can configure a new server which will represent our
`darkirc` instance. First, start weechat, and in its window - run the
`ircd` instance. First, start weechat, and in its window - run the
following commands (there is an assumption that `irc_listen` in the
`darkirc` config file is set to `127.0.0.1:6667`):
`ircd` config file is set to `127.0.0.1:6667`):
```
/server add darkfi localhost/6667 -notls -autoconnect
@@ -132,7 +123,7 @@ connected hosts.
DarkFi supports the use of pluggable transports, including Tor and Nym,
to provide network-level privacy. As long as there are live seed nodes
configured to support a Tor or Nym connection, users can connect to
`darkirc` and benefit from the protections offered by these protocols.
`ircd` and benefit from the protections offered by these protocols.
Other approaches include connecting via a cloud server or VPN. Research
the risks involved in these methods before connecting.
@@ -218,7 +209,7 @@ servers:
/set irc.look.temporary_servers on
Finally you can attach to the local darkirc instances:
Finally you can attach to the local ircd instances:
/connect localhost/6667
/connect localhost/6668

34
doc/src/misc/darkirc/private_message.md → doc/src/misc/ircd/private_message.md
View File

@@ -1,52 +1,52 @@
# Configuring a Private chat between users
Any two users on the `darkirc` server can establish a fully encrypted
Any two users on the `ircd` server can establish a fully encrypted
communication medium between each other using a basic keypair setup.
## Configuring darkirc_config.toml
## Configuring ircd_config.toml
`darkirc_config.toml` should be created by default in `~/.config/darkfi/`
when you first run `darkirc`.
`ircd_config.toml` should be created by default in `~/.config/darkfi/`
when you first run `ircd`.
Generate a keypair using the following command:
```shell
% darkirc --gen-keypair
% ircd --gen-keypair
```
This will generate a Public Key and a Private Key.
Save the Private key safely & add it to the `darkirc_config.toml` file as shown below.
Save the Private key safely & add it to the `ircd_config.toml` file as shown below.
```toml
[private_key.”your_private_key_goes_here”]
```
To share your Public Key with a user over `darkirc` you can use one of the
To share your Public Key with a user over `ircd` you can use one of the
public channels or via an external app like Signal, as plaintext DMs
are disabled in `darkirc`.
are disabled in `ircd`.
<u><b>Note</b></u>: If you use the `darkirc`'s public channel, your
<u><b>Note</b></u>: If you use the `ircd`'s public channel, your
message will be publically visible on the IRC chat.
See the [example darkirc_config.toml](https://github.com/darkrenaissance/darkfi/blob/master/bin/darkirc/darkirc_config.toml) for more details
See the [example ircd_config.toml](https://github.com/darkrenaissance/darkfi/blob/v0.4.1/bin/ircd/ircd_config.toml) for more details
## Example
Lets start by configuring our contacts list in the generated
`darkirc_config.toml` file (you can also refer to the examples written
`ircd_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:
Alice would add bob to her contact list in her own config file:
```toml
[contact.”bob”]
public_key = “D6UzKA6qCG5Mep16i6pJYkUCQcnp46E1jPBsUhyJiXhb”
contact_pubkey = “D6UzKA6qCG5Mep16i6pJYkUCQcnp46E1jPBsUhyJiXhb”
```
And Bob would do the same:
```toml
[contact.”alice”]
public_key = “9sfMEVLphJ4dTX3SEvm6NBhTbWDqfsxu7R2bo88CtV8g”
contact_pubkey = “9sfMEVLphJ4dTX3SEvm6NBhTbWDqfsxu7R2bo88CtV8g”
```
@@ -77,17 +77,13 @@ Or instead of `/msg` command, you can use:
This works exactly the same as `/msg` except it will open a new buffer
with Bob in your client regardless.
Again, you can edit or update the contact list in `darkirc_config.toml`
while the deamon is still running, and request it to reload the updated
config with just sending it a SIGHUP.
<u><b>Note</b></u>: The contact name is not the irc nickname, it can
be anything you want, and you should use it when DMing.
<u><b>Note</b></u>: 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
`darkirc_config.toml` file, you recover the Public Key like so:
`ircd_config.toml` file, you recover the Public Key like so:
```shell
% darkirc --recover-pubkey {your_private_key}
% ircd --recover-pubkey {your_private_key}
```

4
doc/src/misc/darkirc/specification.md → doc/src/misc/ircd/specification.md
View File

@@ -1,9 +1,9 @@
# DarkIRC Specification
# ircd Specification
## PrivMsgEvent
This is the main message type inside `darkirc`. The `PrivMsgEvent` is an
This is the main message type inside `ircd`. The `PrivMsgEvent` is an
[event action](https://darkrenaissance.github.io/darkfi/misc/event_graph/network_protocol.html#event).