-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBuild-Hyperkitty-in-easy-way.html
370 lines (262 loc) · 17.9 KB
/
Build-Hyperkitty-in-easy-way.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<!DOCTYPE html>
<html>
<head>
<!-- [[! Document Settings ]] -->
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<!-- [[! Page Meta ]] -->
<title>Build Hyperkitty in easy way</title>
<meta name="description" content="Google WTM 2017 Scholar|GSoC'17 @Systers|Google Code-In Mentor @Systers|GSoC'16 @Systers|Intern @GeeksforGeeks" />
<meta name="HandheldFriendly" content="True" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="/assets/images/favicon.ico" >
<!-- [[! Styles'n'Scripts ]] -->
<link rel="stylesheet" type="text/css" href="/assets/css/screen.css" />
<link rel="stylesheet" type="text/css"
href="//fonts.googleapis.com/css?family=Merriweather:300,700,700italic,300italic|Open+Sans:700,400" />
<link rel="stylesheet" type="text/css" href="/assets/css/syntax.css" />
<!-- [[! highlight.js ]] -->
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/styles/default.min.css">
<style>.hljs { background: none; }</style>
<!-- [[! Ghost outputs important style and meta data with this tag ]] -->
<link rel="canonical" href="http://aditigupta96.github.io///Build-Hyperkitty-in-easy-way" />
<meta name="referrer" content="origin" />
<link rel="next" href="/page2/" />
<meta property="og:site_name" content="Aditi Gupta" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Build Hyperkitty in easy way" />
<meta property="og:description" content="Google WTM 2017 Scholar|GSoC'17 @Systers|Google Code-In Mentor @Systers|GSoC'16 @Systers|Intern @GeeksforGeeks" />
<meta property="og:url" content="http://aditigupta96.github.io///Build-Hyperkitty-in-easy-way" />
<meta property="og:image" content="/assets/images/15.jpg" />
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:title" content="Build Hyperkitty in easy way" />
<meta name="twitter:description" content="Google WTM 2017 Scholar|GSoC'17 @Systers|Google Code-In Mentor @Systers|GSoC'16 @Systers|Intern @GeeksforGeeks" />
<meta name="twitter:url" content="http://aditigupta96.github.io///Build-Hyperkitty-in-easy-way" />
<meta name="twitter:image:src" content="/assets/images/15.jpg" />
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "Website",
"publisher": "Aditi Gupta",
"name": "Build Hyperkitty in easy way",
"url": "http://aditigupta96.github.io///Build-Hyperkitty-in-easy-way",
"image": "/assets/images/15.jpg",
"description": "Google WTM 2017 Scholar|GSoC'17 @Systers|Google Code-In Mentor @Systers|GSoC'16 @Systers|Intern @GeeksforGeeks"
}
</script>
<meta name="generator" content="Jekyll 3.0.0" />
<link rel="alternate" type="application/rss+xml" title="Aditi Gupta" href="/feed.xml" />
</head>
<body class="home-template nav-closed">
<div class="nav">
<h3 class="nav-title">Menu</h3>
<a href="#" class="nav-close">
<span class="hidden">Close</span>
</a>
<ul>
<li class="nav-home " role="presentation"><a href="/">Home</a></li>
<li class="nav-about " role="presentation"><a href="/about">About</a></li>
<li class="nav-fables " role="presentation"><a href="/resume.pdf">Resume</a></li>
<li class="nav-speeches " role="presentation"><a href="/projects">Projects</a></li>
<!-- <li class="nav-fiction " role="presentation"><a href="/tag/fiction">Fiction</a></li>
<li class="nav-author " role="presentation"><a href="/author/casper">Author</a></li> -->
</ul>
<a class="subscribe-button icon-feed" href="/feed.xml">Subscribe</a>
</div>
<span class="nav-cover"></span>
<div class="site-wrapper">
<!-- [[! Everything else gets inserted here ]] -->
<!-- < default -->
<!-- The comment above "< default" means - insert everything in this file into -->
<!-- the [body] of the default.hbs template, which contains our header/footer. -->
<!-- Everything inside the #post tags pulls data from the post -->
<!-- #post -->
<header class="main-header post-head " style="background-image: url(/assets/images/15.jpg) ">
<nav class="main-nav overlay clearfix">
<a class="blog-logo" href="/"><img src="/assets/images/17.png" alt="Blog Logo" /></a>
<a class="menu-button icon-menu" href="#"><span class="word">Menu</span></a>
</nav>
</header>
<main class="content" role="main">
<article class="post tag-test tag-content">
<header class="post-header">
<h1 class="post-title">Build Hyperkitty in easy way</h1>
<section class="post-meta">
<!-- <a href='/'>Aditi Gupta</a> -->
<time class="post-date" datetime="2016-06-26">26 Jun 2016</time>
<!-- [[tags prefix=" on "]] -->
on
<a href='/tag/Hyperkitty'>Hyperkitty</a>,
<a href='/tag/Mailman3'>Mailman3</a>
</section>
</header>
<section class="post-content">
<p><em>This is a quick guide to build hyperkitty,the archive manager.</em></p>
<p><strong>HyperKitty</strong> is the archiver project for the Mailman 3 suite, allowing users to browse mailing lists, start new threads and reply to existing threads, mark messages as favorite, search archives etc.It is an open source Django application under development. It aims to provide a web interface to access GNU Mailman v3 archives.</p>
<blockquote>
<p><strong>Required Installations</strong></p>
</blockquote>
<ul>
<li>LibSass, a C/C++ port of the Sass engine using :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"> <span class="n">pip</span> <span class="n">install</span> <span class="n">libsass</span>
</code></pre></figure>
</li>
<li> Whoosh, a fast,featureful full-text indexing and searching library implemented in pure Python using :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"> <span class="n">pip</span> <span class="n">install</span> <span class="no">Whoosh</span>
</code></pre></figure>
</li>
</ul>
<blockquote>
<p><strong>Setting up hyperkitty for development</strong></p>
</blockquote>
<ul>
<li> Create virtual environment using :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">virtualenv</span> <span class="o">-</span><span class="nb">p</span> <span class="sr">/usr/</span><span class="n">bin</span><span class="o">/</span><span class="n">python2</span> <span class="n">venv2</span></code></pre></figure>
(Hyperkitty is written in Python2)
</li>
<li> Activate the virtual environment :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">source</span> <span class="n">venv2</span><span class="o">/</span><span class="n">bin</span><span class="o">/</span><span class="n">activate</span></code></pre></figure>
</li>
<li> Clone the hyperkitty repo from gitlab :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"> <span class="n">git</span> <span class="nb">clone</span> <span class="n">https</span><span class="ss">:/</span><span class="o">/</span><span class="n">gitlab</span><span class="p">.</span><span class="nf">com</span><span class="o">/</span><span class="n">mailman</span><span class="o">/</span><span class="n">hyperkitty</span><span class="p">.</span><span class="nf">git</span>
<span class="n">cd</span> <span class="n">hyperkitty</span>
<span class="n">python</span> <span class="n">setup</span><span class="p">.</span><span class="nf">py</span> <span class="n">develop</span></code></pre></figure>
(Make sure to install mailmanclient first)
</li>
</ul>
<blockquote>
<p><strong>Configuration</strong></p>
</blockquote>
<p>Create a <em>settings_local.py</em> in <em>hyperkitty/example_project/</em> repository for development setup having following contents :</p>
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">DEBUG</span> <span class="o">=</span> <span class="no">True</span>
<span class="no">TEMPLATE_DEBUG</span> <span class="o">=</span> <span class="no">DEBUG</span>
<span class="no">USE_SSL</span> <span class="o">=</span> <span class="no">False</span></code></pre></figure>
<blockquote>
<p><strong>Setting up database</strong></p>
</blockquote>
<p><em>Create the Hyperkitty databases using :</em></p>
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">django</span><span class="o">-</span><span class="n">admin</span> <span class="n">migrate</span> <span class="o">--</span><span class="n">pythonpath</span> <span class="n">example_project</span> <span class="o">--</span><span class="n">settings</span> <span class="n">settings</span></code></pre></figure>
<blockquote>
<p><strong>Running HyperKitty</strong></p>
</blockquote>
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">django</span><span class="o">-</span><span class="n">admin</span> <span class="n">runserver</span> <span class="o">--</span><span class="n">pythonpath</span> <span class="n">example_project</span> <span class="o">--</span><span class="n">settings</span> <span class="n">settings</span></code></pre></figure>
<p><em>Make sure to start mailman first using :</em></p>
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">mailman</span> <span class="n">start</span></code></pre></figure>
<p>You would be able to see the hyperkitty page with the message <strong>“No archived lists yet”.</strong></p>
<blockquote>
<p><strong>Importing mailing Lists from mailman</strong></p>
</blockquote>
<p>To view the mailing lists created by you, you need to follow the given steps :</p>
<ul>
<li>Type the following commands in hyperkitty/example_project directory after activating the virtual environment:
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"> <span class="n">python</span> <span class="n">manage</span><span class="p">.</span><span class="nf">py</span> <span class="n">shell</span>
<span class="n">from</span> <span class="n">hyperkitty</span><span class="p">.</span><span class="nf">lib</span><span class="p">.</span><span class="nf">mailman</span> <span class="n">import</span> <span class="n">get_new_lists_from_mailman</span>
<span class="n">get_new_lists_from_mailman</span><span class="p">()</span>
</code></pre></figure>
</li>
<li>Start the server again. Uncheck the *“Hide inactive”* option. You would be able to see all the lists in *“By name”* option.</li>
</ul>
<blockquote>
<p><strong>View emails in hyperkitty</strong></p>
</blockquote>
<p><em>Since,we are running hyperkitty on development server and DEBUG is set to True, we can’t send emails and create threads through hyperkitty ui. We need to send mails through command line.</em></p>
<p><em>To send the mails and view in hyperkitty ui, follow the following steps :</em></p>
<ul>
<li>Activate virtual environment (python3) for mailman using :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">source</span> <span class="n">venv3</span><span class="o">/</span><span class="n">bin</span><span class="o">/</span><span class="n">activate</span></code></pre></figure>
</li>
<li> Create an email.txt file in mailman repository having following contents :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"> <span class="no">From</span><span class="p">:</span> <span class="n">aditi</span><span class="p">.</span><span class="nf">medha96</span><span class="vi">@gmail</span><span class="p">.</span><span class="nf">com</span>
<span class="no">To</span><span class="p">:</span> <span class="nb">test</span><span class="vi">@example</span><span class="p">.</span><span class="nf">net</span>
<span class="no">Subject</span><span class="p">:</span> <span class="no">Test</span>
<span class="no">Message</span><span class="o">-</span><span class="no">ID</span><span class="p">:</span> <span class="o"><</span><span class="n">abcd</span><span class="o">></span>
<span class="no">This</span> <span class="n">is</span> <span class="n">a</span> <span class="n">text</span> <span class="n">message</span>
</code></pre></figure>
</li>
<li>Inject mail in the archive queue using :
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">mailman</span> <span class="n">inject</span> <span class="o">-</span><span class="n">q</span> <span class="n">archive</span> <span class="o">-</span><span class="n">f</span> <span class="n">email</span><span class="p">.</span><span class="nf">txt</span> <span class="nb">test</span><span class="vi">@example</span><span class="p">.</span><span class="nf">net</span></code></pre></figure>
</li>
</ul>
<p>Refresh the hyperkitty page.Now, you would be able to see the email sent to <strong>[email protected]</strong> in hyperkitty ui.</p>
<blockquote>
<p>Please refer to <a href="http://hyperkitty.readthedocs.io/en/latest/install.html">Hyperkitty</a> for latest documentation.</p>
</blockquote>
</section>
<footer class="post-footer">
<!-- Everything inside the #author tags pulls data from the author -->
<!-- #author-->
<figure class="author-image">
<a class="img" href="/author/casper" style="background-image: url(/assets/images/casper2.png)"><span class="hidden">'s Picture</span></a>
</figure>
<section class="author">
<h4><a href="/author/casper">Aditi Gupta</a></h4>
<p> Google WTM 2017 Scholar|GSoC'17 @Systers|Google Code-In Mentor @Systers|GSoC'16 @Systers|Intern @GeeksforGeeks</p>
<div class="author-meta">
<span class="author-location icon-location"> Jaipur, India</span>
<span class="author-link icon-link"><a href="http://aditigupta96.github.io/"> http://aditigupta96.github.io/</a></span>
</div>
</section>
<!-- /author -->
<section class="share">
<h4>Share this post</h4>
<a class="icon-twitter" href="http://twitter.com/share?text=Build Hyperkitty in easy way&url=http://aditigupta96.github.io/Build-Hyperkitty-in-easy-way"
onclick="window.open(this.href, 'twitter-share', 'width=550,height=235');return false;">
<span class="hidden">Twitter</span>
</a>
<a class="icon-facebook" href="https://www.facebook.com/sharer/sharer.php?u=http://aditigupta96.github.io/Build-Hyperkitty-in-easy-way"
onclick="window.open(this.href, 'facebook-share','width=580,height=296');return false;">
<span class="hidden">Facebook</span>
</a>
<a class="icon-google-plus" href="https://plus.google.com/share?url=http://aditigupta96.github.io/Build-Hyperkitty-in-easy-way"
onclick="window.open(this.href, 'google-plus-share', 'width=490,height=530');return false;">
<span class="hidden">Google+</span>
</a>
</section>
<!-- Add Disqus Comments -->
</footer>
</article>
</main>
<aside class="read-next">
<!-- [[! next_post ]] -->
<a class="read-next-story " style="background-image: url(/assets/images/17.jpg)" href="/Send-email-in-a-thread-in-Mailman3">
<section class="post">
<h2>Send email in a thread in Mailman3</h2>
<p>*This is a quick guide to send email in a thread through Mailman3 command line.*...</p>
</section>
</a>
<!-- [[! /next_post ]] -->
<!-- [[! prev_post ]] -->
<a class="read-next-story prev " style="background-image: url(/assets/images/17.jpg)" href="/Essay-Implementation-in-Mailman3">
<section class="post">
<h2>Essay Implementation in Mailman3</h2>
<p>My first task was to implement the essay feature in Mailman3. This is the detailed...</p>
</section>
</a>
<!-- [[! /prev_post ]] -->
</aside>
<!-- /post -->
<footer class="site-footer clearfix">
<section class="copyright"><a href="/">Aditi Gupta</a> © 2017</section>
<section class="poweredby">Proudly published with <a href="https://jekyllrb.com/">Jekyll</a> using <a href="https://github.com/biomadeira/jasper">Jasper</a></section>
</footer>
</div>
<!-- [[! highlight.js ]] -->
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<!-- [[! Ghost outputs important scripts and data with this tag ]] -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
<!-- [[! The main JavaScript file for Casper ]] -->
<script type="text/javascript" src="/assets/js/jquery.fitvids.js"></script>
<script type="text/javascript" src="/assets/js/index.js"></script>
<!-- Add Google Analytics -->
<!-- Google Analytics Tracking code -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-69281367-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>