Ubuntu Server Guide

Merge lp:~dsmythies/serverguide/makefile_changes into lp:~ubuntu-core-doc/serverguide/raring

  1. makefile_changes
  2. Merge into raring
Proposed by Doug Smythies
Status: Merged
Approved by: Doug Smythies
Approved revision: no longer in the source branch.
Merged at revision: 118
Proposed branch: lp:~dsmythies/serverguide/makefile_changes
Merge into: lp:~ubuntu-core-doc/serverguide/raring
Diff against target: 251 lines (+58/-135)
6 files modified
Makefile (+15/-1)
serverguide/C/mail.xml (+43/-2)
serverguide/sample/posfix_commands.sh (+0/-31)
serverguide/sample/postfix_configuration (+0/-40)
serverguide/sample/resolv.conf (+0/-5)
serverguide/sample/sources.list (+0/-56)
To merge this branch: bzr merge lp:~dsmythies/serverguide/makefile_changes
Reviewer Review Type Date Requested Status
Doug Smythies Approve
Review via email: mp+155154@code.launchpad.net

Description of the change

This MP has changes to the Makefile and mail.xml dealing with LP: #1159144 and LP: #972925.

The serverguide HTML was not centered (at least on some browsers), and the methods used in the desktop documentation were pretty much copied to the serverguide Makefile.

There were obsolete and no longer used files in the sample sub-directory. The one file that was still being used was moved to within <programlisting> tags in-line in mail.xml, and the entire sample sub-directory was removed. Why? Because the PDF document must stand by itself and not have relative links to somewhere that doesn't exist if the PDF has been copied elsewhere.

Note: I have no clue what this line in the Makfile does:
                lang=`echo $(LN) | $(SED) -e 's/[@_]/-/'`; \
and I have mindlessly copied it from the desktop Makefile. It might be the case that it is not required for the serverguide.

I realize that the more experienced documentation committers that actually know what is going on and the reasons for that way things are (were) have backed off. However I hope that they will review this.

To post a comment you must log in.
Revision history for this message
Doug Smythies (dsmythies) wrote :

I would be very grateful if someone would review this MP. There will be conflicts (I think) with some coming stuff if not dealt with.
I'll proably wait another day, and then just do it myself, as string freeze is coming and there is still much to do.

Revision history for this message
Doug Smythies (dsmythies) wrote :

I had hoped for someone else to review this, but now will just self approve and merge it.
I'll beg forgivness later if it causes problems.
There isn't much time left before string freeze, with still lots to do, and limited time available to dedicate to the serverguide.

review: Approve
lp:~dsmythies/serverguide/makefile_changes updated
118. By Doug Smythies

Edits per MP: #155154; LP: #1159171 and LP: #972925 center html and eliminate sample directory; by Doug Smythies

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'Makefile'
2--- Makefile 2012-04-06 12:53:52 +0000
3+++ Makefile 2013-03-24 22:58:21 +0000
4@@ -20,6 +20,7 @@
5 ####################################################################################
6
7 MAKECMD=make
8+SED=/bin/sed
9
10 # Language code for documents
11 # Ex. LN=ja for japanese
12@@ -61,15 +62,28 @@
13
14 serverguide-html:
15
16+# Builds the HTML files for the specified language codes.
17+# Specifiying the language in the final documents and
18+# performing some other necessary text replacements not handled by yelp-build.
19+# Language codes are normalized to IETF format, as opposed to glibc format
20+
21 if [ $(LN) != "C" ]; then \
22 ./scripts/translate.sh -d serverguide -l $(LN); \
23 fi
24 if find serverguide/$(LN) -name "*.xml"; then \
25 mkdir -p build/serverguide/$(LN); \
26 yelp-build html -o build/serverguide/$(LN) -x $(UBUNTUXSL) serverguide/$(LN)/serverguide.xml; \
27- cp -r serverguide/sample build/serverguide/; \
28 mkdir -p build/img; \
29 cp libs/img/* build/img/; \
30+ lang=`echo $(LN) | $(SED) -e 's/[@_]/-/'`; \
31+ if test "$$lang" = "C"; then lang=en; fi; \
32+ if test "$$lang" = "gl"; then lang=gl-GL; fi; \
33+ if test "$$lang" = "ms"; then lang=ms-MS; fi; \
34+ if test "$$lang" = "pl"; then lang=pl-PL; fi; \
35+ $(SED) -i \
36+ -e '1s/^/<!DOCTYPE html\>\n/' \
37+ -e "s/<html>/<html lang="$$lang">/" \
38+ build/serverguide/$(LN)/*.html; \
39 fi
40
41 serverguide-pdf:
42
43=== modified file 'serverguide/C/mail.xml'
44--- serverguide/C/mail.xml 2013-03-06 00:22:48 +0000
45+++ serverguide/C/mail.xml 2013-03-24 22:58:21 +0000
46@@ -182,9 +182,50 @@
47 </para>
48 </note>
49 <para>
50- Now, the file <filename>/etc/postfix/main.cf</filename>
51- should look like <ulink url="../sample/postfix_configuration">this</ulink>.
52+ Now, the file <filename>/etc/postfix/main.cf</filename> should look like this:
53 </para>
54+<programlisting>
55+# See /usr/share/postfix/main.cf.dist for a commented, more complete
56+# version
57+
58+smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
59+biff = no
60+
61+# appending .domain is the MUA's job.
62+append_dot_mydomain = no
63+
64+# Uncomment the next line to generate "delayed mail" warnings
65+#delay_warning_time = 4h
66+
67+myhostname = server1.example.com
68+alias_maps = hash:/etc/aliases
69+alias_database = hash:/etc/aliases
70+myorigin = /etc/mailname
71+mydestination = server1.example.com, localhost.example.com, localhost
72+relayhost =
73+mynetworks = 127.0.0.0/8
74+mailbox_command = procmail -a "$EXTENSION"
75+mailbox_size_limit = 0
76+recipient_delimiter = +
77+inet_interfaces = all
78+smtpd_sasl_local_domain =
79+smtpd_sasl_auth_enable = yes
80+smtpd_sasl_security_options = noanonymous
81+broken_sasl_auth_clients = yes
82+smtpd_recipient_restrictions =
83+permit_sasl_authenticated,permit_mynetworks,reject _unauth_destination
84+smtpd_tls_auth_only = no
85+smtp_tls_security_level = may
86+smtpd_tls_security_level = may
87+smtp_tls_note_starttls_offer = yes
88+smtpd_tls_key_file = /etc/ssl/private/smtpd.key
89+smtpd_tls_cert_file = /etc/ssl/certs/smtpd.crt
90+smtpd_tls_CAfile = /etc/ssl/certs/cacert.pem
91+smtpd_tls_loglevel = 1
92+smtpd_tls_received_header = yes
93+smtpd_tls_session_cache_timeout = 3600s
94+tls_random_source = dev:/dev/urandom
95+</programlisting>
96 <para>
97 The postfix initial configuration is complete. Run
98 the following command to restart the postfix daemon:
99
100=== removed directory 'serverguide/sample'
101=== removed file 'serverguide/sample/posfix_commands.sh'
102--- serverguide/sample/posfix_commands.sh 2011-05-03 07:11:18 +0000
103+++ serverguide/sample/posfix_commands.sh 1970-01-01 00:00:00 +0000
104@@ -1,31 +0,0 @@
105-postconf -e 'smtpd_sasl_local_domain ='
106-postconf -e 'smtpd_sasl_auth_enable = yes'
107-postconf -e 'smtpd_sasl_security_options = noanonymous'
108-postconf -e 'broken_sasl_auth_clients = yes'
109-postconf -e 'smtpd_recipient_restrictions = permit_sasl_authenticated,permit_mynetworks,reject_unauth_destination'
110-postconf -e 'inet_interfaces = all'
111-echo 'pwcheck_method: saslauthd' >> /etc/postfix/sasl/smtpd.conf
112-echo 'mech_list: plain login' >> /etc/postfix/sasl/smtpd.conf
113-
114-mkdir /etc/postfix/ssl
115-cd /etc/postfix/ssl/
116-openssl genrsa -des3 -rand /etc/hosts -out smtpd.key 1024
117-chmod 600 smtpd.key
118-openssl req -new -key smtpd.key -out smtpd.csr
119-openssl x509 -req -days 3650 -in smtpd.csr -signkey smtpd.key -out smtpd.crt
120-openssl rsa -in smtpd.key -out smtpd.key.unencrypted
121-mv -f smtpd.key.unencrypted smtpd.key
122-openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.pem -days 3650
123-
124-postconf -e 'smtpd_tls_auth_only = no'
125-postconf -e 'smtp_tls_security_level = may'
126-postconf -e 'smtpd_tls_security_level = may'
127-postconf -e 'smtp_tls_note_starttls_offer = yes'
128-postconf -e 'smtpd_tls_key_file = /etc/postfix/ssl/smtpd.key'
129-postconf -e 'smtpd_tls_cert_file = /etc/postfix/ssl/smtpd.crt'
130-postconf -e 'smtpd_tls_CAfile = /etc/postfix/ssl/cacert.pem'
131-postconf -e 'smtpd_tls_loglevel = 1'
132-postconf -e 'smtpd_tls_received_header = yes'
133-postconf -e 'smtpd_tls_session_cache_timeout = 3600s'
134-postconf -e 'tls_random_source = dev:/dev/urandom'
135-postconf -e 'myhostname = mail.example.com'
136
137=== removed file 'serverguide/sample/postfix_configuration'
138--- serverguide/sample/postfix_configuration 2011-05-03 07:11:18 +0000
139+++ serverguide/sample/postfix_configuration 1970-01-01 00:00:00 +0000
140@@ -1,40 +0,0 @@
141-# See /usr/share/postfix/main.cf.dist for a commented, more complete
142-# version
143-
144-smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
145-biff = no
146-
147-# appending .domain is the MUA's job.
148-append_dot_mydomain = no
149-
150-# Uncomment the next line to generate "delayed mail" warnings
151-#delay_warning_time = 4h
152-
153-myhostname = server1.example.com
154-alias_maps = hash:/etc/aliases
155-alias_database = hash:/etc/aliases
156-myorigin = /etc/mailname
157-mydestination = server1.example.com, localhost.example.com, localhost
158-relayhost =
159-mynetworks = 127.0.0.0/8
160-mailbox_command = procmail -a "$EXTENSION"
161-mailbox_size_limit = 0
162-recipient_delimiter = +
163-inet_interfaces = all
164-smtpd_sasl_local_domain =
165-smtpd_sasl_auth_enable = yes
166-smtpd_sasl_security_options = noanonymous
167-broken_sasl_auth_clients = yes
168-smtpd_recipient_restrictions =
169-permit_sasl_authenticated,permit_mynetworks,reject _unauth_destination
170-smtpd_tls_auth_only = no
171-smtp_tls_security_level = may
172-smtpd_tls_security_level = may
173-smtp_tls_note_starttls_offer = yes
174-smtpd_tls_key_file = /etc/ssl/private/smtpd.key
175-smtpd_tls_cert_file = /etc/ssl/certs/smtpd.crt
176-smtpd_tls_CAfile = /etc/ssl/certs/cacert.pem
177-smtpd_tls_loglevel = 1
178-smtpd_tls_received_header = yes
179-smtpd_tls_session_cache_timeout = 3600s
180-tls_random_source = dev:/dev/urandom
181
182=== removed file 'serverguide/sample/resolv.conf'
183--- serverguide/sample/resolv.conf 2011-05-03 07:11:18 +0000
184+++ serverguide/sample/resolv.conf 1970-01-01 00:00:00 +0000
185@@ -1,5 +0,0 @@
186-search com
187-nameserver 204.11.126.131
188-nameserver 64.125.134.133
189-nameserver 64.125.134.132
190-nameserver 208.185.179.218
191
192=== removed file 'serverguide/sample/sources.list'
193--- serverguide/sample/sources.list 2012-10-18 06:32:10 +0000
194+++ serverguide/sample/sources.list 1970-01-01 00:00:00 +0000
195@@ -1,56 +0,0 @@
196-# deb cdrom:[Ubuntu 12.10 _Quantal Quetzal_ - Beta i386 (20120421)]/ quantal main restricted
197-
198-# See http://help.ubuntu.com/community/UpgradeNotes for how to upgrade to
199-# newer versions of the distribution.
200-deb http://us.archive.ubuntu.com/ubuntu/ quantal main restricted
201-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal main restricted
202-
203-## Major bug fix updates produced after the final release of the
204-## distribution.
205-deb http://us.archive.ubuntu.com/ubuntu/ quantal-updates main restricted
206-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-updates main restricted
207-
208-## N.B. software from this repository is ENTIRELY UNSUPPORTED by the Ubuntu
209-## team. Also, please note that software in universe WILL NOT receive any
210-## review or updates from the Ubuntu security team.
211-deb http://us.archive.ubuntu.com/ubuntu/ quantal universe
212-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal universe
213-deb http://us.archive.ubuntu.com/ubuntu/ quantal-updates universe
214-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-updates universe
215-
216-## N.B. software from this repository is ENTIRELY UNSUPPORTED by the Ubuntu
217-## team, and may not be under a free licence. Please satisfy yourself as to
218-## your rights to use the software. Also, please note that software in
219-## multiverse WILL NOT receive any review or updates from the Ubuntu
220-## security team.
221-deb http://us.archive.ubuntu.com/ubuntu/ quantal multiverse
222-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal multiverse
223-deb http://us.archive.ubuntu.com/ubuntu/ quantal-updates multiverse
224-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-updates multiverse
225-
226-## N.B. software from this repository may not have been tested as
227-## extensively as that contained in the main release, although it includes
228-## newer versions of some applications which may provide useful features.
229-## Also, please note that software in backports WILL NOT receive any review
230-## or updates from the Ubuntu security team.
231-deb http://us.archive.ubuntu.com/ubuntu/ quantal-backports main restricted universe multiverse
232-deb-src http://us.archive.ubuntu.com/ubuntu/ quantal-backports main restricted universe multiverse
233-
234-deb http://security.ubuntu.com/ubuntu quantal-security main restricted
235-deb-src http://security.ubuntu.com/ubuntu quantal-security main restricted
236-deb http://security.ubuntu.com/ubuntu quantal-security universe
237-deb-src http://security.ubuntu.com/ubuntu quantal-security universe
238-deb http://security.ubuntu.com/ubuntu quantal-security multiverse
239-deb-src http://security.ubuntu.com/ubuntu quantal-security multiverse
240-
241-## Uncomment the following two lines to add software from Canonical's
242-## 'partner' repository.
243-## This software is not part of Ubuntu, but is offered by Canonical and the
244-## respective vendors as a service to Ubuntu users.
245-# deb http://archive.canonical.com/ubuntu quantal partner
246-# deb-src http://archive.canonical.com/ubuntu quantal partner
247-
248-## This software is not part of Ubuntu, but is offered by third-party
249-## developers who want to ship their latest software.
250-deb http://extras.ubuntu.com/ubuntu quantal main
251-deb-src http://extras.ubuntu.com/ubuntu quantal main

Subscribers

People subscribed via source and target branches