Skip to content

A RESTful Java based Access Control List (ACL) implementation.

License

Notifications You must be signed in to change notification settings

ElmarDott/TP-ACL

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Together Platform :: ACL

License Apache 2 Maven Central Javadocs Build Status Coverage Status Codacy Badge

Getting Started

Access Control List. Functions - Release: 1.0

  • [ACL-00] Domain Desription
  • [ACL-01] Registration
  • [ACL-02] Login
  • [ACL-03] Logout
  • [ACL-04] Reset Password
  • [ACL-05] Activate / Deactivate Accounts
  • [ACL-06] Configure Module

Please also check out the Wiki for further information.

Prerequisites

The ACL Module is build with NetBeans, Maven and Java SE (openJDK). The most important dependencies are Hibernate, Spring and JUnit 5. As Database Server (DBMS) PostgeSQL DBMS 11 is recommended.

Docker was chosen for an simple and fast database setup. In the case you wish to have a short introduction about docker, you can check my tutorial on BitCute. After on your system docker is running, you are be able to setup the database by the following steps:

docker network create -d bridge --subnet=172.18.0.0/16 services

docker run -d --name postgres --restart=no
-p 5432:5432 --net services --ip 172.18.0.2
-e POSTGRES_PASSWORD=s3cr3t
-e PGPASSWORD=s3cr3t
-v /home/user/docker/postgres:/var/lib/postgresql/data
postgres:11

docker run -d --name pgadmin --restart=no
-p 8004:80 --net services --ip 172.18.0.98
-e PGADMIN_DEFAULT_EMAIL=myself@sample.com
-e PGADMIN_DEFAULT_PASSWORD=s3cr3t
--link postgres:11
dpage/pgadmin4:4.29

URI/> 172.17.0.1:5432 User: postgres PWD: n/a DOC/> https://docs.docker.com/samples/library/postgres/

  • docker start postgres
  • docker stop postgres

To create default user and schemata (also for testing), you are be able to use TP-CM/dbms/src/sql/initial_postgresql.sql script.

Build

TP-ACL uses always the current version of Apache Maven. To build the project by your own you will need the current version from the master branch of the parent-pom from the TP-CM project (build-workflow).

TP-ACL depends on TP-CORE.

The project configurations are available in src/main/filter/ directory.

In the case no DBMS is available, all test cases which depend on Database access will skipped.

Installing

All released artifacts are available on Maven Central for free usage. You are be able to use the released artifact in your project as dependency with the following entry:

Maven

<dependency>
    <groupId>io.github.together.modules.acl</groupId>
    <artifactId>api</artifactId>
    <version>1.0.0</version>
</dependency>
<dependency>
    <groupId>io.github.together.modules.acl</groupId>
    <artifactId>server</artifactId>
    <version>1.0.0</version>
</dependency>
<dependency>
    <groupId>io.github.together.modules.acl</groupId>
    <artifactId>client</artifactId>
    <version>1.0.0</version>
</dependency>

Authors

License

This project is licensed under the Apache 2.0 license.

Contributors

Feel free open a pull request or to send a feature request by e-mail in the case you want to contribute the project. Everyone is welcome, even beginners in programming. I also appreciate help by optimizing the documentation and creating tutorials.

Mistakes happen. But we only able to fix them, when we you inform us you found a bug. Do not hesitate to send a report in the way you feel common. I try to give as much as possible fast & direct support.

In the case you like this project, let me know it and rate it with a star.

About

A RESTful Java based Access Control List (ACL) implementation.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages