Documentation

documentation@lists.ipfire.org

226 discussions

Need some reviews, please
by Carlo Fusco 15 Sep '16

15 Sep '16

On Tue, Sep 13, 2016 at 7:24 AM, R. W. Rodolico <rodo(a)dailydata.net> wrote: [cut] > > When I first started doing any documentation, I was scared to change > anything, and I believe I caused the development team more trouble > fixing my messups than I actually helped. Because of this, I started > looking more closely at the "how do we document the project" idea. thank you for doing that, as a newbie I appreciate very much this work. > > I reorganized http://wiki.ipfire.org/projects/docs/start slightly to put > articles about "How to write articles" in the bottom section, "Wiki > guideline". from the point of view of a newbie can I make a suggestion? Can you incorporate in the main text what is now in the link http://wiki.ipfire.org/en/edit In other words, make it explicit what to do. Something along this line, Do you want to contribute to improve the documentations? First read these links and then open an account etc.. > At Mr. Tremer's suggestion, I then read (kind of), an original document > at http://wiki.ipfire.org/test. It is in German! > > NOTE: I do not speak German. I speak three languages; English, Bad > English and Very, Very Bad Spanish. You'll note that German is not > listed there at all. Learning to count to 29 on my grandmothers knee > does not count as speaking German. Nor does 6 weeks of German class in > college. This was all about Google Translate and guessing. That article > (in Bad English) is at > http://wiki.ipfire.org/projects/docs/quick_syntax_overview and > desperately needs review. I don't understand, what's wrong with this: http://wiki.ipfire.org/wiki/syntax which I believe is part of the standard documentation of DokuWIki. Did you want a more synthetic document? Regardless, I think that the links to the documentation in German should be removed. > > Finally, I decided we needed some quick guidelines, so I wrote > http://wiki.ipfire.org/projects/docs/basic_documentation_guidelines. That's very, very nice. Thank you for doing this. As I said, as a newbie I really appreciate this work. I didn't know about the namespace issues you described so well, clear and to the point. I like it. Thanks again, including for all your help and encouragement. -- Carlo Fusco -- Carlo Fusco

1 0

Fwd: New version of Proxy access control list documentation
by Carlo Fusco 15 Sep '16

15 Sep '16

On Thu, Sep 15, 2016 at 4:04 AM, R. W. Rodolico <rodo(a)dailydata.net> wrote: > Sorry you had to run into it so soon. Not your fault man. Don't worry. I will help to clean it up. I am planning to write one more entry, this time on the configuration of hostapd and then I am done, as I pretty much reached the limits of my knowledge. However after that, I could go trough the wiki with a fine tooth comb to identify dead links, empty pages, orphaned text and unclear structure. If you agree, together we can fix these issues. -- Carlo Fusco

1 0

Fwd: New version of Proxy access control list documentation
by Carlo Fusco 15 Sep '16

15 Sep '16

On Wed, Sep 14, 2016 at 8:37 PM, Matthias Fischer < matthias.fischer(a)ipfire.org> wrote: > I found something else: > > It's not necessary that the file 'include.acl' contains the lines... > > # start of ... > ... > # end of ... > > ...because these lines are automatically added when saving through the > GUI => 'proxy.cgi', lines ~3602ff. > yeah, good catch. The wiki refers to what will be in squid.conf, so technically the text was correct, however it was really confusing too. I did add a sentence to remove the confusion. Please let me know if you don't find it clear enough or incorrect. -- Carlo Fusco -- Carlo Fusco

1 0

Need some reviews, please
by R. W. Rodolico 15 Sep '16

15 Sep '16

When I first decided to pay back some of the benefit I received from this project, I realized I do not have the dedication or time to be a developer. So, I test and document. When I first started doing any documentation, I was scared to change anything, and I believe I caused the development team more trouble fixing my messups than I actually helped. Because of this, I started looking more closely at the "how do we document the project" idea. I reorganized http://wiki.ipfire.org/projects/docs/start slightly to put articles about "How to write articles" in the bottom section, "Wiki guideline". At Mr. Tremer's suggestion, I then read (kind of), an original document at http://wiki.ipfire.org/test. It is in German! NOTE: I do not speak German. I speak three languages; English, Bad English and Very, Very Bad Spanish. You'll note that German is not listed there at all. Learning to count to 29 on my grandmothers knee does not count as speaking German. Nor does 6 weeks of German class in college. This was all about Google Translate and guessing. That article (in Bad English) is at http://wiki.ipfire.org/projects/docs/quick_syntax_overview and desperately needs review. Finally, I decided we needed some quick guidelines, so I wrote http://wiki.ipfire.org/projects/docs/basic_documentation_guidelines. Again, this definitely is not a finished project, and it is mainly filled with guesses at what our basic guidelines should be. I did try to read some of the other articles to see what these guidelines should be, but feel free to tell me I'm way off base. Feedback??? Please! I have very thick skin, so tons of negative feedback will not hurt my feelings. I just want someplace we can send new documenters to and say "here, read this if you want to know how we do things." Rod -- Rod Rodolico Daily Data, Inc. POB 140465 Dallas TX 75214-0465 214.827.2170 http://www.dailydata.net

2 2

New version of Proxy access control list documentation
by Carlo Fusco 15 Sep '16

15 Sep '16

Dear List, please review the following wiki section: http://wiki.ipfire.org/en/configuration/network/proxy/wui_conf/access which I heavily modified from the previous text. The part I modified is in between: begin section to be reviewed end section to be reviewed I particular, please check carefully the part before the image of the web interface and the paragraphs titled: Disable internal proxy access to Green from other subnets and Disable internal proxy access to other subnets from the Blue IP space (except the IPFire machine itself): Let me state that the author(s) of this text did an amazing job and allowed me to understand how to configure the proxy the way I wanted. My modifications are intended only to try to make it more clear to a beginner and to correct an error in the text, as discussed previously in other mails on this list. I welcome any criticism. I will wait until you give me permission to remove the "under review" notice. Thank you. Cheers. -- Carlo Fusco

3 5

reviewing of wiki proposed wiki modifications
by Carlo Fusco 10 Sep '16

10 Sep '16

Hello, while I am not a system or network administrator (in my day job I am a molecular biologist), I have been using IPFIRE for a while, first by setting up a router/firewall/proxy for a friend and now using it in my home. I am studying and experimenting quite a lot these days and probably I can help to improve the documentation. Even if English is not my first language, I use it every day on my job and I can write and communicate quite decently. I already have in mind several modifications to the wiki, however I am not comfortable to do so without first some competent peer review, as I am not a professional and frequently I do get things wrong. Is this effort welcome? If yes, where do I submit my drafts? Here, or in the forums? If the latter, which one? The developers or the general one? Thanks, Cheers. -- Carlo Fusco

3 2

Fwd: wrong section in Squid network based access control
by Carlo Fusco 08 Sep '16

08 Sep '16

My apologies, I sent this message to Rodo instead to the list. Damn. I will pay more attention to what I am doing in the future. My apologies also to Rodo for the double post. ---------- Forwarded message ---------- From: Carlo Fusco <fusco.carlo(a)gmail.com> Date: Wed, Sep 7, 2016 at 10:54 AM Subject: Re: wrong section in Squid network based access control To: "R. W. Rodolico" <rodo(a)dailydata.net> On Tue, Sep 6, 2016 at 8:12 PM, R. W. Rodolico <rodo(a)dailydata.net> wrote: > Honestly, I do not know. Maybe we can get information from one of the > developers? Unless you know for certain? It sounds like you have used > the proxy a lot more than I have. Do you know for sure which way it works? > I am quite positive. If I check that box, it will write this on /var/ipfire/proxy/squid.conf > #Prevent internal proxy access from Blue except IPFire itself > http_access allow IPFire_blue_network IPFire_blue_servers > http_access deny IPFire_blue_network !IPFire_ips IPFire_servers The code looks simple enough to me. The first line allows the blue network to access the blue IP space. The second line denies access to the rest of the network (IPFire_servers), which in my case is green and orange IP space. The exception is the IPFire machine itself (IPFire_ips) which is allowed. Besides, the comment "Prevent internal proxy access from Blue except IPFire itself" looks to me quite clear. If there are no objections, I would correct the text in the wiki. -- Carlo Fusco -- Carlo Fusco

1 0

wrong section in Squid network based access control
by Carlo Fusco 06 Sep '16

06 Sep '16

Dear List, I believe there is an error in the following excerpt from the link: http://wiki.ipfire.org/en/configuration/network/proxy/wui_conf/access [quote] *Disable internal proxy access to Blue from other subnets:* = If the proxy is activated and used for both zones (blue and green), there is the possibility to reach the blue zone from the green zone via http or https over the proxy. At this moment the zone separation produced by IPTables is bypassed. If this should be prevented, a hook needs to be set. [end quote] I believe this text has it backward. That checkbox is to prevent the blue zone to access any IP outside the blue network not the other way around. If you agree I will change the text accordingly. -- Carlo Fusco

2 1

review: New section in General information about Squid
by Carlo Fusco 06 Sep '16

06 Sep '16

Dear List, please review the proposed section, which I included in the following link: http://wiki.ipfire.org/en/configuration/network/proxy/general My text has a warning title and it is (temporarily) set in italics. It ends before the "Caching" section. Thank you. Cheers, -- Carlo Fusco

2 1

Is anyone still working on documentation?
by R. W. Rodolico 20 Jul '16

20 Jul '16

I haven't seen a lot of traffic on this list recently, and wanted to see where we were. I know I, personally, have not been thinking in terms of documentation. Rod -- Rod Rodolico Daily Data, Inc. POB 140465 Dallas TX 75214-0465 214.827.2170 http://www.dailydata.net

2 1

← Newer
1
2
3
4
5
6
7
8
...
23
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

Documentation