Skip to content
Permalink
Browse files

feat: improve installation guide (#36)

  • Loading branch information...
ykzts committed Aug 25, 2019
1 parent c4a250b commit 79fe77272b976a458dc7595ebacfbdceffc65f5e
@@ -1,12 +1,10 @@
---
title: Documentation
title: Welcome to Manael!
linkTitle: Documentation
weight: 20
menu:
main:
weight: 20
---

## Welcome to Manael!

Manael is an HTTP proxy that converts JPEG and PNG to WebP. Placing between the storage server and the cache server provides optimal resource conversion.

This file was deleted.

@@ -0,0 +1,48 @@
---
title: Installation Guide
linkTitle: Installation Guide
---

## Using the Docker

The Manael recommends running on [Docker](https://www.docker.com/). A Docker image is published on [Docker Hub](https://hub.docker.com/).

Get it with `docker pull manael/manael:lates` command before running the Manael with the Docker. Using the Docker eliminates a need to add unnecessary files to your environment.

## Using a built binary

You can download the Manael built for 64bit GNU/Linux.

### 1. Create a working directory

First, create a working directory to extract the downloaded file when installing Manael.

```console
$ mkdir manael
$ cd manael
```

### 2. Download

Download the latest version of Manael (`manael_1.x.y_Linux_x86_64.tar.gz`) from [release page](https://github.com/manaelproxy/manael/releases). Then, extract the downloaded file to the directory created in 1.

```console
$ wget https://github.com/manaelproxy/manael/releases/download/v1.x.y/manael_1.x.y_Linux_x86_64.tar.gz
$ tar xf manael_1.x.y_Linux_x86_64.tar.gz
```

### 3. Install

Use the `install` command to copy the file. You can do the same thing with the `cp` and `mv` commands, but using the `install` command gives the executable the appropriate execution permissions.

```console
$ sudo install manael /usr/local/bin
```

## Build from a source code

A source code is hosted on [GitHub](https://github.com/manaelproxy/manael). The Manael is written in [Go](https://golang.org/).

```console
$ go build -o manael cmd/manael/main.go
```
@@ -1,12 +1,10 @@
---
title: ドキュメント
title: Manael へようこそ!
linkTitle: ドキュメント
weight: 20
menu:
main:
weight: 20
---

## Manael へようこそ!

Manael は JPEG と PNG を WebP に変換する HTTP プロキシです。ストレージサーバーとキャッシュサーバーの間に配置すると最適なリソース変換が行われます。

This file was deleted.

@@ -0,0 +1,48 @@
---
title: インストール手順
linkTitle: インストール手順
---

## Docker を使う

Manael は [Docker](https://www.docker.com/) で動かすことを推奨しています。Manael の Docker イメージは [Docker Hub](https://hub.docker.com/) で公開されています。

Manael を Docker を使って動かす場合は `docker pull manael/manael:latest` コマンドで取得してください。Docker を使うことによって既存の環境に不必要なファイルを増やさずに最新版の Manael が使えるようになります。

## ビルド済みバイナリを使う

64 ビット版の GNU/Linux を対象にしてビルドされた Manael をダウンロードできます。

### 1. ディレクトリを作る

まず Manael をインストールする際にダウンロードしたファイルを展開するためのディレクトリを作ります。

```console
$ mkdir manael
$ cd manael
```

### 2. ダウンロード

[リリースページ](https://github.com/manaelproxy/manael/releases)から最新版の Manael (`manael_1.x.y_Linux_x86_64.tar.gz`) をダウンロードして 1. で作ったディレクトリに展開します。

```console
$ wget https://github.com/manaelproxy/manael/releases/download/v1.x.y/manael_1.x.y_Linux_x86_64.tar.gz
$ tar xf manael_1.x.y_Linux_x86_64.tar.gz
```

### 3. インストール

ファイルをコピーするために `install` コマンドを利用します。`cp` コマンドや `mv` コマンドでも同様の作業はできますが、`install` コマンドを使うことによって適切な実行権限が実行ファイルに与えられます。

```console
$ sudo install manael /usr/local/bin
```

## ソースコードからビルド

Manael のソースコードは [GitHub](https://github.com/manaelproxy/manael) にホストされています。Manael は [Go](https://golang.org/) で書かれていて、`go` コマンドを使って簡単にビルドできます。

```console
$ go build -o manael cmd/manael/main.go
```

0 comments on commit 79fe772

Please sign in to comment.
You can’t perform that action at this time.