CategolJ2 Backend

CategoljJ2 is a micro blog system. This backend provides REST API for blog system and admin console to manage these data. You can create any blog frontend using this APIs ;)

The following technologies are used.

Java 8
Spring Boot 1.2
- Spring 4.1
- Spring MVC
- Spring Security OAuth
- Spring Data JPA
- JPA 2.1
- Flyway
- ThymeLeaf
Hibernate Search
React.js
Backbone.js
...

Normal launch

Download categolj2-backend.jar (0.20.0+) from release page. This jar is executable by Spring Boot.

Note that CategoLJ2 requires Java8.

Simple usage

$ java -Xms512m -Xmx1g -jar categolj2-backend.jar --server.port 8080

Access

Backend
- http://localhost:8080/admin
- login with initial account (admin/demo)
Sample frontend
- http://localhost:8080
- see Setup frontend to customize frontend screen.

CategoLJ2 supports H2 and MySQL and embedded H2 is used as default.

You can change H2 data location as following:

$ java -Xms512m -Xmx1g -jar categolj2-backend.jar --server.port 8080 --categolj2.h2.datadir=./foobar

When you would like to use MySQL then:

$ java -Xms512m -Xmx1g -jar categolj2-backend.jar --server.port 8080 --spring.jpa.database=MYSQL --spring.datasource.driverClassName=com.mysql.jdbc.Driver --spring.datasource.url=jdbc:mysql://localhost:3306/categolj2?zeroDateTimeBehavior=convertToNull --spring.datasource.username=root --spring.datasource.password=password

In this case, you have to run create database categolj2 using mysql command in advance.

Other properties are explained in Configurable properties.

Docker Support

If Docker is not installed follow this: https://docs.docker.com/installation/

Build Application

cd categolj2-backend
(Optional) mvn clean install -f frontend-ui/pom.xml -Dgpg.skip=true
(Optional) mvn clean install -f backend-ui/pom.xml -Dgpg.skip=true
cd backend-api
mvn clean package
cd target
docker build -t categolj2-backend .

Deploy to Docker Container

docker images # List all Docker images
docker run -p 80:80 -p 443:443 <image id>

Run with deployed Docker image

You can use deployed Docker image.

Run with the following command:

docker run -d \
--name categolj2 \
-p 80:80 \
-p 443:443 \
-v /tmp/categolj2:/tmp \
-v /var/log/categolj2:/var/log/categolj2 \
-e "_JAVA_OPTIONS=-Duser.timezone=JST \
-Xms512m \
-Xmx1g" \
making/categolj2-backend \
--spring.thymeleaf.cache=true \
--log.verbose=WARN \
--logging.level.jdbc.resultsettable=ERROR \
--logging.level.jdbc.sqltiming=ERROR \
--logging.level.org=WARN \
--logging.level.am=WARN \
--logging.level./=WARN \
--logging.level.am.ik.categolj2.App=INFO \
--logging.level.org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter=INFO

Go to http://<Docker Host IP>

In case of using MySQL, docker-compose.yml is really useful.

$ cd backend-api/docker/docker-compose.yml
$ docker-compose up

After this command, MySQL and CategoLJ2 will run and connect ;)

Go to http://<Docker Host IP>

1st log will be as follows:

$ docker-compose up
Creating target_mysql_1...
Creating target_categolj2_1...
Attaching to target_mysql_1, target_categolj2_1
mysql_1     | Running mysql_install_db ...
mysql_1     | 2015-05-06 18:39:46 0 [Note] /usr/sbin/mysqld (mysqld 5.6.24-log) starting as process 13 ...
...
mysql_1     | 2015-05-06 18:40:16 13 [Note] InnoDB: Setting log file ./ib_logfile1 size to 1024 MB
mysql_1     | InnoDB: Progress in MB: 100 200 300 400 500 600 700 800 900 1000
categolj2_1 | Picked up _JAVA_OPTIONS: -Duser.timezone=JST -Djava.awt.headless=false -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/categolj2/ -Xloggc:/var/log/categolj2/gc.log -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=5 -XX:GCLogFileSize=10M -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=80 -XX:MaxTenuringThreshold=10 -XX:ErrorFile=/var/log/categolj2/hs_err_pid%p.log
categolj2_1 |
categolj2_1 | 2015-05-06 18:40:50.642  INFO 1 --- [           main] am.ik.categolj2.App                      : Starting App v1.0.0-SNAPSHOT on 95041a7555f9 with PID 1 (/opt/categolj2-backend/categolj2-backend.jar started by root in /opt/categolj2-backend)
mysql_1     | 2015-05-06 18:40:51 13 [Note] InnoDB: Renaming log file ./ib_logfile101 to ./ib_logfile0
...
mysql_1     | 2015-05-06 18:41:01 1 [Note] Execution of init_file '/tmp/mysql-first-time.sql' started.
mysql_1     | 2015-05-06 18:41:01 1 [Warning] 'proxies_priv' entry '@ root@abc9de9b36f2' ignored in --skip-name-resolve mode.
mysql_1     | 2015-05-06 18:41:01 1 [Note] Execution of init_file '/tmp/mysql-first-time.sql' ended.
mysql_1     | 2015-05-06 18:41:01 1 [Note] mysqld: ready for connections.
mysql_1     | Version: '5.6.24-log'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server (GPL)
categolj2_1 | 2015-05-06 18:41:01.973  INFO 1 --- [           main] am.ik.categolj2.config.InfraConfig       : Check DB availability... (172.17.0.87:3306)
categolj2_1 | 2015-05-06 18:41:02.696  INFO 1 --- [           main] am.ik.categolj2.config.InfraConfig       : OK
categolj2_1 | 2015-05-06 18:41:31.401  INFO 1 --- [           main] o.s.w.s.c.a.WebMvcConfigurerAdapter      : Adding welcome page: jar:file:/opt/categolj2-backend/categolj2-backend.jar!/lib/categolj2-frontend-ui-backbonejs-1.0.0-SNAPSHOT.jar!/META-INF/resources/index.html
categolj2_1 | 2015-05-06 18:41:33.267  INFO 1 --- [           main] am.ik.categolj2.App                      : Started App in 43.453 seconds (JVM running for 73.168)

It will be slow because mysql is initialized.

2nd+ will be the following:

$ docker-compose up
Recreating target_mysql_1...
Recreating target_categolj2_1...
Attaching to target_mysql_1, target_categolj2_1
categolj2_1 | Picked up _JAVA_OPTIONS: -Duser.timezone=JST -Djava.awt.headless=false -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/categolj2/ -Xloggc:/var/log/categolj2/gc.log -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=5 -XX:GCLogFileSize=10M -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=80 -XX:MaxTenuringThreshold=10 -XX:ErrorFile=/var/log/categolj2/hs_err_pid%p.log
categolj2_1 |
mysql_1     | 2015-05-06 18:45:55 0 [Note] mysqld (mysqld 5.6.24-log) starting as process 1 ...
...
mysql_1     | 2015-05-06 18:45:57 1 [Note] mysqld: ready for connections.
mysql_1     | Version: '5.6.24-log'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server (GPL)
categolj2_1 | 2015-05-06 18:46:08.999  INFO 1 --- [           main] am.ik.categolj2.App                      : Starting App v1.0.0-SNAPSHOT on 115ef47bee44 with PID 1 (/opt/categolj2-backend/categolj2-backend.jar started by root in /opt/categolj2-backend)
categolj2_1 | 2015-05-06 18:46:19.909  INFO 1 --- [           main] am.ik.categolj2.config.InfraConfig       : Check DB availability... (172.17.0.90:3306)
categolj2_1 | 2015-05-06 18:46:20.642  INFO 1 --- [           main] am.ik.categolj2.config.InfraConfig       : OK
categolj2_1 | 2015-05-06 18:46:35.776  INFO 1 --- [           main] o.s.w.s.c.a.WebMvcConfigurerAdapter      : Adding welcome page: jar:file:/opt/categolj2-backend/categolj2-backend.jar!/lib/categolj2-frontend-ui-backbonejs-1.0.0-SNAPSHOT.jar!/META-INF/resources/index.html
categolj2_1 | 2015-05-06 18:46:37.982  INFO 1 --- [           main] am.ik.categolj2.App                      : Started App in 29.826 seconds (JVM running for 34.083)

Backend APIs

Supported REST APIs are following.

Resource	Method	Path	Description	Pageable	Authenticated
Entries	GET	/api/v1/entries	Get all entries	×
Entries	GET	/api/v1/entries?keyword={keyword}	Search entries	×
Entries	GET	/api/v1/categories/{category}/entries	Get all entries associated with the specified category.	×
Entries	GET	/api/v1/users/{createdBy}/entries	Get all entries created with the specified user.	×
Entries	POST	/api/v1/entries	Create a new entry.		×
Entry	GET	/api/v1/entries/{entryId}	Get the specified entry.
Entry	PUT	/api/v1/entries/{entryId}	Update the specified entry.		×
Entry	DELETE	/api/v1/entries/{entryId}	Delete the specified entry.		×
Entry Histories	GET	/api/v1/entries/{entryId}/histories	Get all entry histories associated with the specified entry.		×
Categories	GET	/api/v1/categories	Get all categories.
Categories	GET	/api/v1/categories?keyword={keyword}	Search categories.		×
Recent Posts	GET	/api/v1/recentposts	Get entries updated recently.
Users	GET	/api/v1/users	Get all users.	×	×
Users	POST	/api/v1/users	Create a new user.		×
User	GET	/api/v1/users/{username}	Get the specified user.		×
User	PUT	/api/v1/users/{username}	Update the specified user.		×
User	DELETE	/api/v1/users/{username}	Delete the specified user.		×
User	GET	/api/v1/users/me	Get login user.		×
User	PUT	/api/v1/users/me	Update login user. (not implemented yet)		×
Links	GET	/api/v1/links	Get all links.
Links	POST	/api/v1/links	Create a new link.		×
Link	GET	/api/v1/links/{url}	Get the specified link.
Link	PUT	/api/v1/links/{url}	Update the specified link.		×
Link	DELETE	/api/v1/links/{url}	Delete the specified link.		×
Files	GET	/api/v1/files	Get all file summaries (not include file contents).	×	×
Files	POST	/api/v1/files Upload files.		×
File	GET	/api/v1/files/{fileId}	Get the specified file.
File	GET	/api/v1/files/{fileId}?attachment	Download the specified file (with prompt).
File	DELETE	/api/v1/files/{fileId}	Delete the specified file.		×
Books	GET	/api/v1/books?title={title}	Search books by the given title using Amazon Product API		×
Books	GET	/api/v1/books?keyword={keyword}	Search books by the given keyword using Amazon Product API		×

Admin Console Screenshots

Admin console is a single page application using AJAX/REST API mentioned above.

Dashboard

Manage entries

Entry list

Entry form

You can write contents using Markdown or raw HTML.

Entry preview

Live preview is available.

File upload

You can upload files to use the entry on the fly. HTML5 multiple attribute is supported.

Amazon search

You can insert book link using Amazon Product API.

run with --aws.accesskey.id=<Your Accesskey ID for AWS> --aws.secret.accesskey=<Your Secret Accesskey for AWS> --aws.associate.tag=<Your Associate Tag>

Entry search

Full text search is available.

Manage uploaded files

Manage users

User list

User edit

Inline edit is available.

Manage links

Setup frontend

The following sample fronted is embedded by default:

You can use your own frontend.

Create static/index.html at the same directory with categol2-backend.jar like bellow:

$ find .
.
./categolj2-backend.jar
./static
./static/index.html

After run java -jar categolj2-backend.jar, you can find the following log which tells your own welcome page was picked.

2014-12-20 20:48:13.126  INFO                                    --- [           main] o.s.w.s.c.a.WebMvcConfigurerAdapter      : Adding welcome page: file:/xxx/yyy/zzz/static/index.html

You can reuse embedded frontend. Embedded html/css/javascript are zipped in categol2-backend.jar.

$ unzip -d foo categol2-backend.jar
$ unzip -d bar foo/lib/categolj2-frontend-ui*
$ cp -r bar/META-INF/resources static

Configurable properties

Key	Description	Default value
log.verbose	set this property `warn` if you want to suppress the output of verbose log.
log.sql	set this property `warn` if you want to suppress SQL log.	debug
log.sql.result	set this property `debug` if I want to output SQL result log.	error
hibernate.search.default.indexBase	file path storing Lucene index	/tmp/lucene
aws.accesskey.id	access key ID for AWS	<Your Accesskey ID for AWS>
aws.secret.accesskey	secret accesskey for AWS	<Your Secret Accesskey for AWS>
aws.endpoint	AWS endpoint	https://ecs.amazonaws.jp
aws.associate.tag	Associate Tag for Amazon Affiliate	ikam-22
accesslog.disabled	Disable to write access logs	false

If you want suppress debug logs, run with like --log.verbose=warn --log.sql=warn.

See also Spring Boot's common application properties.

License

Licensed under the Apache License, Version 2.0.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

CategolJ2 Backend

Normal launch

Simple usage

Docker Support

Run with deployed Docker image

Backend APIs

Admin Console Screenshots

Dashboard

Manage entries

Entry list

Entry form

Entry preview

File upload

Amazon search

Entry search

Manage uploaded files

Manage users

User list

User edit

Manage links

Setup frontend

Configurable properties

License

Files

README.md

Latest commit

History

README.md

File metadata and controls

CategolJ2 Backend

Normal launch

Simple usage

Docker Support

Run with deployed Docker image

Backend APIs

Admin Console Screenshots

Dashboard

Manage entries

Entry list

Entry form

Entry preview

File upload

Amazon search

Entry search

Manage uploaded files

Manage users

User list

User edit

Manage links

Setup frontend

Configurable properties

License