memcached-manager.github.io/index.html at master · memcached-manager/memcached-manager.github.io · GitHub

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
<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <title>Memcached Manager</title>

    <link rel="stylesheet" href="stylesheets/styles.css">
    <link rel="stylesheet" href="stylesheets/pygment_trac.css">
    <link rel="stylesheet" href="stylesheets/custom.css">
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
  </head>
  <body>
    <div class="wrapper">
      <header>
        <div><img id="logo" src="images/logo.png" /></div>
        <p>The definitive solution to manage your memcached server.</p>
        <p class="view"><a href="https://github.com/memcached-manager/memcached-manager">View project on Github</a></p>

        <iframe src="https://ghbtns.com/github-btn.html?user=memcached-manager&repo=memcached-manager&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
      </header>
      <section>
        <p>Miss being able to actually know what's inside your memcached server in a simple way? Memcached Manager is there for you.</p>

        <h2>
        <a id="screenshots" class="anchor" href="#screenshots" aria-hidden="true"><span class="octicon octicon-link"></span></a>What does it do?</h2>

        <ul>
          <li>
            A CRUD to your memcached server: Create, Read, Update or Delete any key without using an archaic direct telnet connection.
            <p><img class="screenshot" src="images/crud-stuff.png" /></p>
          </li>

          <li>
            Find any key you want with a regexp.
            <p><img class="screenshot" src="images/search.png" /></p>
          </li>

          <li>
            Check how much time is left for any key to expire or how much size it occupies.
            <p><img class="screenshot" src="images/menu.png" /></p>
          </li>

          <li>
            Type anything on a terminal connection directly with the memcached server, no need to telnet anymore.
            <p><img class="screenshot" src="images/terminal-mode.png" /></p>
          </li>
        </ul>

        <p>All that packaged in a web interface -- just install it and use it! It's also pluggable to any rack/rails application with just <em>one line</em> of programming.</p>

        <h2>
        <a id="ok-i-want-it-how-do-i-install" class="anchor" href="#ok-i-want-it-how-do-i-install" aria-hidden="true"><span class="octicon octicon-link"></span></a>Ok, I want it. How do I install?</h2>

        <ol>
        <li>
        <p>Install the gem.</p>

        <pre><code>gem install memcached-manager</code></pre>
        </li>
        <li>
        <p>Run memcached-manager with your memcached up</p>

        <pre><code>memcached-manager</code></pre>
        </li>
        </ol>

        <p>If your memcached is running on a different domain or port(locahost:11211):</p>

        <pre><code>memcached-manager -H foo.bar -P 1337</code></pre>

        <p>or</p>

        <pre><code>memcached-manager --memcached-host foo.bar --memcached-port 1337
        </code></pre>

        <h2>
        <a id="plugging-memcached-manager-to-an-existing-rails-app" class="anchor" href="#plugging-memcached-manager-to-an-existing-rails-app" aria-hidden="true"><span class="octicon octicon-link"></span></a>Plugging memcached manager to an existing Rails app</h2>

        <p>Just mount it in your routes(<em>config/routes.rb</em>) file:</p>

        <pre><code>mount MemcachedManager::Routes, :at =&gt; '/mm'
        </code></pre>

        <p>So it will be accessible in the "/mm" route of your application.</p>

        <p>If you want to specify a different configuration than the defaults(localhost:11211) add an <em>.env</em> file with the following:</p>

        <pre><code>memcached_host: foo.bar
        memcached_port: 1337
        </code></pre>

        <h2>
          <a id="requirements" class="anchor" href="#requirements" aria-hidden="true"><span class="octicon octicon-link"></span></a>Requirements
        </h2>

        <pre><code>Ruby &gt;= 1.9.3
        Memcached (of course)
        </code></pre>


        <h2>
          <a id="contributors" class="anchor" href="#contributors" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contributors
        </h2>

        <ul>
          <li>
            <p><a href='mailto:ami_sama@hotmail.com'>Ami Onodera</a> - Made the logo.</p>
          </li>
        </ul>

        <h2>
          <a id="copyright" class="anchor" href="#copyright" aria-hidden="true"><span class="octicon octicon-link"></span></a>Copyright
        </h2>
        <p>Copyright © 2013-2015 Thiago Fernandes Massa. The MIT license.</p>

      </section>
      <footer>
        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
      </footer>
    </div>
    <script src="javascripts/scale.fix.js"></script>
  </body>
</html>