Reformulated a few things in the readme
このコミットが含まれているのは:
コミット
4563b81698
35
README.md
35
README.md
|
@ -9,16 +9,17 @@ on.
|
|||
|
||||
[I2Pd](https://i2pd.website/) is packaged in
|
||||
[OpenBSD](https://www.openbsd.org/)'s official repositories, but the provided
|
||||
versions are old, and older versions don't always run reliably when interacting
|
||||
with newer versions on the I2P network.
|
||||
versions are usually old, and older versions don't always run reliably when
|
||||
interacting with newer versions on the I2P network.
|
||||
|
||||
Fortunately, compiling the latest version from source on OpenBSD is painless.
|
||||
LibreSSL is supported, the official instructions work out of the box, and only a
|
||||
small manual intervention is required to make the daemon start at system boot.
|
||||
|
||||
This repository contains instructions on how to compile I2Pd on OpenBSD together
|
||||
with a makefile and an RC script to make it a system service, which allows it
|
||||
to be started at boot, restarted if it crashes, managed by `rcctl`, and more.
|
||||
with a makefile and an RC script to make it a system service. This allows it
|
||||
to be started at boot, to be managed by `rcctl`, to be restarted if it crashes,
|
||||
etc.
|
||||
|
||||
|
||||
## Compiling and installing
|
||||
|
@ -32,8 +33,8 @@ stated here.
|
|||
|
||||
First, install
|
||||
[a few dependencies](https://i2pd.readthedocs.io/en/latest/devs/building/requirements/).
|
||||
Git is not in their list, but is needed as it does not come with OpenBSD's base
|
||||
system:
|
||||
Git is not listed as a dependency in the official build documentation, but it is
|
||||
needed as it does not come with OpenBSD's base system:
|
||||
|
||||
$ doas pkg_add boost cmake git lzlib
|
||||
|
||||
|
@ -42,7 +43,7 @@ Next, clone their git repository:
|
|||
$ cd /a/folder/of/your/choice/where/to/clone/the/repo
|
||||
$ git clone https://github.com/PurpleI2P/i2pd.git
|
||||
|
||||
Then, generate the makefile and compile the source. You can
|
||||
Then, generate the makefile and compile the source. You can also
|
||||
[pass options to cmake](https://i2pd.readthedocs.io/en/latest/devs/building/unix/#cmake-options)
|
||||
to customize your makefile:
|
||||
|
||||
|
@ -87,29 +88,31 @@ end of `/etc/login.conf` to create the login class:
|
|||
|
||||
If you are using OpenBSD 7.1 or newer, a login class can be created by adding a
|
||||
file in `/etc/login.conf.d`. The makefile ran in the next steps detects the
|
||||
version and creates the file automatically.
|
||||
version and creates the file automatically if the version is 7.1 or newer.
|
||||
|
||||
The new login class will be used by the user `_i2pd` created in the following
|
||||
steps. Next, clone this git repository:
|
||||
This new login class will be used by the user `_i2pd` created in the following
|
||||
steps.
|
||||
|
||||
Next, clone this git repository:
|
||||
|
||||
$ cd /a/folder/of/your/choice/where/to/clone/the/repo
|
||||
$ git clone https://gitlab.com/alpou/i2pd-rc-openbsd.git
|
||||
|
||||
Then, simply run the makefile. This step creates a dedicated `_i2pd` user and a
|
||||
group of the same name if they don't already exist, creates the login class
|
||||
described above if you are using OpenBSD 7.1 or newer, makes the binaries
|
||||
previously compiled belong to them, and copies the init script in `/etc/rc.d`.
|
||||
Then, simply run the makefile. This will create a dedicated user and group to run
|
||||
I2Pd, both called `_i2pd`, and give them ownership of the binaries compiled
|
||||
previously. The login class described above will also be created if you are using
|
||||
OpenBSD 7.1 or newer, and the init script will be copied in `/etc/rc.d`.
|
||||
|
||||
$ cd i2pd-rc-openbsd
|
||||
$ doas make install
|
||||
|
||||
The final step is to enable the service to make it start at boot time and to
|
||||
The final step is to enable the service to make it start at boot time and then to
|
||||
manually start it:
|
||||
|
||||
$ doas rcctl enable i2pd
|
||||
$ doas rcctl start i2pd
|
||||
|
||||
Enjoy!
|
||||
You're done. Enjoy!
|
||||
|
||||
|
||||
## Licensing
|
||||
|
|
読み込み中…
新しいイシューから参照