diff --git a/docs/user-guide/family.md b/docs/user-guide/family.md index 729bef3..4f9eb30 100644 --- a/docs/user-guide/family.md +++ b/docs/user-guide/family.md @@ -16,9 +16,9 @@ Use the following list of commands to do this through openssl: touch v3.ext openssl x509 -req -days 3650 -in .csr -signkey .key -out .crt -extfile v3.ext -Specify .family.i2p.net for the CN (Common Name) when requested. +Specify <your family name>.family.i2p.net for the CN (Common Name) when requested. -Once you are done generating it place .key and .crt in the /family folder (for example ~/.i2pd/family). +Once you are done generating it place <your-family-name>.key and <your-family-name>.crt in the /family folder (for example ~/.i2pd/family). You should provide these two files to other members joining your family. If you want to register your family and let the I2P network recognize it, create a pull request for your .crt file into contrib/certificate/family. Certificates added into the public repository this way will appear in i2pd and I2P next releases packages. Don't place .key file, it must be shared between you family members only. @@ -31,7 +31,7 @@ Once you and that family agree to do it, they must give you .key and .crt file a Publish your family ------------------- -Run i2pd with the parameters 'family=', and make sure you have .key and .crt in your 'family' folder. +Run i2pd with the parameters 'family=<your-family-name>', and make sure you have <your-family-name>.key and <your-family-name>.crt in your 'family' folder. If everything is set properly, you router.info will contain two new fields: 'family' and 'family.sig'. If not, your router will complain on startup with log messages starting with "Family:" prefix and severity 'warn' or 'error'.