Skip to content

Commit ed31342

Browse files
committed
improve information respect recent changes
1 parent 379db08 commit ed31342

File tree

3 files changed

+47
-16
lines changed

3 files changed

+47
-16
lines changed

LOGIN.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# codeigniter-login files
22

3+
The login process uses a Controller that process the login and logout,
4+
such controller implements the check that currently are into a model,
5+
but you can change it to another class or just a if-else or whatever check.
6+
7+
There's no need if you want, you can setup a method in the `webappweb/models/Usersmodel.php`
8+
that just use your own storage, user check or way to autenticate the user data.
9+
10+
By default this project uses a embebed sqlite3 database, that you can
11+
change or move it.
12+
313
## Database
414

515
Since version 2.0.0 the project need a database connection, use the files
6-
at [webappdb](webappdb) directory.
16+
at `webappdb` directory.
717

818
Until version 1.0.0 the check per se is made at the file `Indexauth.php` in the auth function..
919
the line of the variable `$rs_access` has the status.. if not TRUE or not NULL the check is passed.
@@ -17,6 +27,9 @@ and `webappweb/config/imap.php`, `$im_access` is the result of the mail login ch
1727
Since version 4.0.0 a main controller do the check work of the sesion at `webappweb/core/CP_Controller.php`
1828
that all controllers inherit, so `$this->checksession();` is common functionality and reusable code.
1929

30+
Since version 5.0.0 the project provide a sqlite database, by default its
31+
at `webappdb/codeigniter.db` and extra view/controller are show to noted more the sesion handle.
32+
2033
## Development
2134

2235
The core core process is just 4 files, if you dont use the profiler neither database or imap auth:
@@ -112,12 +125,12 @@ The magic is done by the `auth($data = NULL, ... , ... )`
112125

113126
## Authors and acknowledgment
114127

115-
Show your appreciation to those who have contributed to the project.
128+
* (c) PICCORO Lenz McKAY @mckaygerhard
116129

117130
## License
118131

119-
For open source projects, say how it is licensed.
132+
CC-BY-SA
120133

121-
## Project status
134+
## see also
122135

123-
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
136+
[README.md](README.md)

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,48 @@ Login template for codeigniter repo, this project just use session files, the mo
44

55
The project its at https://gitlab.com/codeigniterpower/codeigniter-login
66

7-
## Installation
7+
## How to use:
8+
9+
The project is just 4 files in fact, check [Development](#development) section in this document.
10+
11+
#### Installation
812

913
Just clone the repo:
1014

1115
```
1216
mkdir ~/Devel && ~/Devel
1317
1418
git clone --recursive https://gitlab.com/codeigniterpower/codeigniter-login
15-
1619
```
1720

1821
Then enable "user directory" module into your webserver, change "public_html" to "Devel
1922
and visit `http://localhost/~general/codeigniter-login`
2023

21-
## Deploy into your webserver
24+
#### Deploy into your webserver
2225

2326
Just clone the repo:
24-
2527
```
2628
mkdir /var/www/html && /var/www/html
2729
2830
git clone --recursive https://gitlab.com/codeigniterpower/codeigniter-login
29-
3031
```
3132

3233
Then enable the site and visit `http://localhost/codeigniter-login`
3334

3435
## Database
3536

37+
There's no need if you want can setup a method in the [webappweb/models/Usersmodel.php](webappweb/models/Usersmodel.php)
38+
that just use your own storage, user check or way to autenticate the user data.
39+
40+
By default this project uses a embebed sqlite3 database, that you can
41+
change or move it, just by configure it on [webappweb/config/database.php](webappweb/config/database.php).
42+
3643
Since version 2.0.0 the project need a database connection, use the files
3744
at [webappdb](webappdb) directory.
3845

46+
Since version 5.0.0 the project provide a sqlite database, by default its
47+
at [webappdb/codeigniter.db](webappdb/codeigniter.db).
48+
3949
## Development
4050

4151
The core core process is just 4 files, complete documented at the [LOGIN.md](LOGIN.md) document:
@@ -68,6 +78,9 @@ and `webappweb/config/imap.php`, `$im_access` is the result of the mail login ch
6878
Since version 4.0.0 a main controller do the check work of the sesion at `webappweb/core/CP_Controller.php`
6979
that all controllers inherit, so `$this->checksession();` is common functionality and reusable code.
7080

81+
Since version 5.0.0 the project provide a sqlite database, by default its
82+
at `webappdb/codeigniter.db` and extra view are show to noted more the sesion handle.
83+
7184
For mode detailed please read the [LOGIN.md](LOGIN.md) document
7285

7386
#### Profiler and debugging
@@ -95,12 +108,9 @@ For mode detailed please read the [LOGIN.md](LOGIN.md) document
95108

96109
## Authors and acknowledgment
97110

98-
Show your appreciation to those who have contributed to the project.
111+
* (c) PICCORO Lenz McKAY @mckaygerhard
99112

100113
## License
101114

102-
For open source projects, say how it is licensed.
103-
104-
## Project status
115+
CC-BY-SA
105116

106-
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

webappdb/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
The Database is just a simple table, with simple columns,
33
the model just check both arguments and returns all the data,
44

5+
## Model desing
6+
7+
There's no need if you want can setup a method in the [webappweb/models/Usersmodel.php](../webappweb/models/Usersmodel.php)
8+
that just use your own storage or way to autenticate the user data.
9+
10+
By default this project uses a embebed sqlite3 database, that you can
11+
change or move it, just by configure it on [webappweb/config/database.php](../webappweb/config/database.php).
12+
513
## Compatibility
614

715
The DB is designed using mysqlworkbench but the generated sql file
@@ -19,4 +27,4 @@ will make it compatible, just use `; -- COMMENT`.
1927

2028
Then inside mysqlworkbench use comments to describe the dictionary.
2129

22-
![](codeigniter.png)
30+
![](codeigniter.png)

0 commit comments

Comments
 (0)