halo/docs/README-en-US.md

6.6 KiB
Executable File
Raw Blame History

Halo

Halo may be the best Java blog system.

Author JDK GitHub release Travis CI Docker Build Status


🇨🇳简体中文 | 🇺🇸English

Introduction

Halo [ˈheɪloʊ], Become the best blogging system using Java.

Fast, concise, and powerful blogging system developed in Java.

QQ Group: 162747721Telegram Group: https://t.me/HaloBlog | WeHalo 小程序

Quick start

Deploy with shell script

# install Halo
yum install -y wget && wget -O halo-cli.sh https://git.io/fxHqp && bash halo-cli.sh -i

# upgrade Halo
bash halo-cli.sh -u

Deploy with Docker

# pull docker images
docker pull ruibaby/halo

# create docker container and run it
docker run -d --name halo -p 8090:8090 -v ~/halo:/root/halo ruibaby/halo

Deploy with Docker compose

# Download the nginx config file template
curl https://raw.githubusercontent.com/jwilder/nginx-proxy/master/nginx.tmpl > /etc/nginx/nginx.tmpl

# Get the docker-compose.yaml
yum install -y wget && wget -O docker-compose.yaml https://git.io/fpS8N

# Modify docker-compose.yaml, modify VIRTUAL_HOST, LETSENCRYPT_HOST for your own domain name, and modify LETSENCRYPT_I@RYANC.CC to your own mailbox.

# run
docker-compose up -d

Tips: If you use Idea, Eclipse and other IDEs to run, you need to install the Lombok plugin, In addition, JDK10 is not supported at the moment, and there are problems with themes scanning and uploading. See the Halo documentation or Wiki for more details.

Blogs with Halo

Ryan0up'S Blog

SNAIL BLOG

宋浩志博客

KingYiFan'S Blog

AquanBlog

Themes

In addition to the built-in Anatole and Material, there are the following The theme is not integrated in the project. If you need it, please download it and upload it through the background.

Disclaimer: Do not accept any comments or suggestions on the functionality of the Porting Theme.

License

license

Halo uses the GPL-v3.0 protocol to open source.

Thanks

The birth of Halo is inseparable from the following projects

  • Spring Boot: Spring's rapid development framework
  • Freemarker: Template engine to make pages static
  • H2 Database: Embedded database, no need to install
  • Spring-data-jpa: a persistence layer framework that does not require writing sql statements
  • Ehcache: Cache Framework
  • Lombok: Make the code simpler
  • oh-my-email: Probably the smallest Java mailing library, support for CC, attachments, templates, etc.
  • Hutool: A Java Foundation Tools library
  • Thumbnailator: thumbnail generation library
  • AdminLTE: Bootstrap-based background template
  • Bootstrap: The most widely used front-end ui framework
  • Animate: Very easy to use css effects library
  • SimpleMDE - Markdown Editor: Simple, functional, and lightweight Markdown editor
  • Bootstrap-FileInput: Bootstrap-based file upload component
  • Font-awesome: the most widely used font icon library
  • JQuery: The most widely used JavaScript framework
  • Layer: Personally think that the most practical and best-looking pop-up layer component, no one
  • JQuery-Toast : message prompt component
  • Pjax: pushState + ajax = pjax
  • OwO: front-end expression library

Donate

If Halo is helpful to you, ask the author to have a .

Alipay Wechat Alipay Red envelope

Interface display