I2P Documentation Project

Aus i2pwiki.mk16.de
Zur Navigation springen Zur Suche springen

The I2P Documentation Project, launched in summer 2016, is a unofficial I2P project currently headed by SGLG. Since it is unofficial, don't pester the I2P devs if there is a problem with this project or the documents produced by it.

The goal of this project is to document everything that a user of I2P could ever need to know about I2P. All the way from getting on I2P for the first time, to contributing to I2P project development. No longer will there be a lack of documentation concerning I2P. No longer will a new user be puzzled about what they can or can't do with I2P, how to use it, or what it's best for.

This project needs volunteers. It's a huge project and one person (me) can't go it all alone. If you have some spare time and know some things about I2P and/or using I2P, please consider volunteering. Contribute what you can. Not only will we need people to write documentation, we will also need people to proofread, update, and translate documentation. We also need people to point new users to finished documentation so they can be better prepared to use I2P.

List of Pages[Bearbeiten]

There's a dynamic list of related pages. If when you create new pages, prefix it with I2P Documentation Project/ and it'll be seen in this list.

Stage 1[Bearbeiten]

Beginner? This is where you start.

Stage 2[Bearbeiten]

Like to know more? Want to contribute to the community? Read on.

Stage 3[Bearbeiten]

Help the I2P project by contributing, reporting bugs and general network things.


Project information[Bearbeiten]

Members[Bearbeiten]

Project Lead: SGLG

Volunteers:

  • (Anonymous)

To contact, either click on "Discussion" at the top of the page or visit the IRC2P channel #i2pdocs.

Stages[Bearbeiten]

  1.  Stage One of the project is aimed at totally new users of I2P. In stage one, we need to document everything related to obtaining I2P, installing it on the various operating systems it works with, configuring it to get the most out of it (and the importance of contributing to the network), setting up a browser, and joining the IRC server.
    • How to Obtain I2P (Windows and Linux)<ref>http://i2p-projekt.i2p/en/download</ref>
    • Why you need to use I2P (such as Why privacy matters, censorship, and so forth)
    • Things to do after installing I2P (setting bandwidth and bandwidth sharing percentage, port forwarding and firewalls, addressbook subscriptions, and so forth)
    • Setting up a browser for I2P use (modifying the Tor browser for use with I2P, using other browsers, things to keep in mind, advantages of a dedicated browser, disadvantages of using regular browsers, and so forth. Windows and Linux)
    • Browsing eepsites (note about loading/reloading<ref>http://echelon.i2p/docs/hardtoreach.txt</ref>, how leaving the router up longer will lead to better responsiveness, lists of eepsites, and so forth).
    • File sharing (the various methods of file sharing, how to setup any clients, what to keep in mind, EXIF data and similar, and best practices.
    • Installing, configuring, and using an IRC client (aimed at those new to IRC and those who just want to connect to the I2P version (see also JIRCii client). Also covering connecting to unofficial IRC servers. Things to keep in mind when using IRC. Importance of keeping quiet about certain sensitive information such as timezone, country of origin, current time, operating system specifics, router uptime, and so forth.
    • Best practices when using I2P (covering things a user should and shouldn't do on I2P to help protect their identity, privacy, and so forth)
  2.  Stage Two of the project is aimed at users who know a little about I2P or have been around a little bit, but want to learn more. In this stage, we need to document more advanced topics such as file sharing, advanced tweaking of I2P, using various I2P specific software<ref>see: Category:I2P-Software</ref>, hosting eepsites, and so forth.
  3. Stage Three of the project is aimed at advanced users. In this stage, we need to document far more advanced topics such as contributing code to the I2P project, hunting down bugs<ref>http://trac.i2p2.i2p/</ref> and vulnerabilities, and various more advanced topics that only advanced users would be interested in.


Possibly useful links[Bearbeiten]


References[Bearbeiten]

<references />