Browse Source

update mkdocs to new format, change favicon and delete unused pages (#92)

Signed-off-by: R4SAS <r4sas@i2pmail.org>
pull/93/head
R4SAS 9 months ago committed by GitHub
parent
commit
dabea5c4f4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 15
      docs/devs/building/index.md
  2. BIN
      docs/img/favicon.ico
  3. BIN
      docs/media/i2pd-logo.png
  4. 43
      docs/user-guide/config_opts_after_2.3.0.md
  5. 6
      mkdocs.yml

15
docs/devs/building/index.md

@ -1,15 +0,0 @@ @@ -1,15 +0,0 @@
Build requirements
==================
In general, for building i2pd you need several things:
* compiler with c++11 support (for example: gcc >= 4.7, clang)
* boost >= 1.49
* openssl library
* zlib library (openssl already depends on it)
Optional tools:
* cmake >= 2.8 (or 3.3+ if you want to use precompiled headers on windows)
* miniupnp library (for upnp support)
* [websocketpp](https://github.com/zaphoyd/websocketpp/) (for websocket ui)

BIN
docs/img/favicon.ico

Binary file not shown.

After

Width:  |  Height:  |  Size: 153 KiB

BIN
docs/media/i2pd-logo.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

43
docs/user-guide/config_opts_after_2.3.0.md

@ -1,43 +0,0 @@ @@ -1,43 +0,0 @@
Изменения обработки параметров в релизах > 2.3.0
------------------------------------------------
Система параметров отличается от того, что было ранее и достаточно сильно:
* изменения имён и стиля параметров
Все параметры теперь в виде --help (gnu-style), у некоторых есть шорткаты в виде -h (unix-style).
Это касается всех систем, в том числе винды.
--daemon=1 и подобное -> просто --daemon, без параметра. Нет опции - false, есть - true
--notransit=1 -> --notransit, то же что и выше: есть опция - false, нет - true
--v6 -> --ipv6 (первое было похоже на версию какого-то своего протокола, типа socksproxy --v5)
--tunnelscfg -> --tunconf (имя параметра было слишком длинным, cfg переделан на conf - единообразно с --conf)
--sockskeys -> разделён на два, для socks и httpproxy по-отдельности
* поддержка секций в основном конфиге
Выглядит это так:
# основные опции
pidfile = /var/run/i2pd.pid
#
# настройки конкретного модуля
[httproxy]
address = 1.2.3.4
port = 4446
keys = httproxy-keys.dat
# и так далее
[sam]
enabled = no
address = 127.0.0.2
# ^^ переопределяется только адрес, остальное берётся из дефолта
Точно так же сейчас работает конфиг туннелей: секция до точки - имя, после - параметр
* поддержка выключения отдельных сервисов "на корню" см sam.enabled и подобное
Это позволило задать дефолт для номера порта и не писать его руками для включения.
* добавлен --help (см #110)
* присутствует некая валидация параметров, --port=abcd - не прокатит, --port=100500 - тоже

6
mkdocs.yml

@ -5,9 +5,7 @@ site_author: PurpleI2P Team @@ -5,9 +5,7 @@ site_author: PurpleI2P Team
repo_url: https://github.com/PurpleI2P/i2pd_docs_en
site_favicon: media/i2pd-logo.png
pages:
nav:
- Home: index.md
- User Guide:
- Installing: user-guide/install.md
@ -54,4 +52,4 @@ theme: readthedocs @@ -54,4 +52,4 @@ theme: readthedocs
markdown_extensions:
- toc:
permalink:
permalink: true

Loading…
Cancel
Save