readme.md
1# phpLiteAdmin
2
3Website: https://www.phpliteadmin.org/
4
5Bitbucket: https://bitbucket.org/phpliteadmin/public/
6
7## What is phpLiteAdmin?
8
9phpLiteAdmin is a web-based SQLite database admin tool written in PHP with
10support for SQLite3 and SQLite2. Following in the spirit of the flat-file system
11used by SQLite, phpLiteAdmin consists of a single source file, phpliteadmin.php,
12that is dropped into a directory on a server and then visited in a browser.
13There is no installation required. The available operations, feature set,
14interface, and user experience is comparable to that of phpMyAdmin.
15
16## News
17
18**05.09.2019: phpLiteAdmin 1.9.8.2 released [Download now](https://www.phpliteadmin.org/download/)**
19
20**03.09.2019: phpLiteAdmin 1.9.8.1 released [Download now](https://www.phpliteadmin.org/download/)**
21
22**30.08.2019: phpLiteAdmin 1.9.8 released [Download now](https://www.phpliteadmin.org/download/)**
23
24**17.08.2017: [Security alert: phpLiteAdmin 1.9.8-dev](https://www.phpliteadmin.org/2017/08/17/security-alert-1-9-8-dev/) (stable versions not affected)**
25
26**14.12.2016: Just released phpLiteAdmin 1.9.7.1 as 1.9.7 was built incorrectly [Download now](https://www.phpliteadmin.org/download/)**
27
28**13.12.2016: Just released phpLiteAdmin 1.9.7! [Download now](https://www.phpliteadmin.org/download/)**
29
30**05.07.2015: Just released phpLiteAdmin 1.9.6! [Download now](https://www.phpliteadmin.org/download/)**
31
32## Features
33
34- Lightweight - consists of a single 200KB source file for portability
35- Supports SQLite3 and SQLite2 databases
36- Translated and available in over 10 languages - and counting
37- Specify and manage an unlimited number of databases
38- Specify a directory and optionally its subdirectories to scan for databases
39- Create and delete databases
40- Add, delete, rename, empty, and drop tables
41- Browse, add, edit, and delete records
42- Add, delete, and edit table columns
43- Manage table indexes
44- Manage table triggers
45- Import and export tables, structure, indexes, and data (SQL, CSV)
46- View data as bar, pie, and line charts
47- Graphical search tool to find records based on specified field values
48- Create and run your own custom SQL queries in the free-form query editor/builder
49- Easily apply core SQLite functions to column values using the GUI
50- Write your own PHP functions to be available to apply to column values
51- Design your own theme using CSS or install a pre-made theme from the community
52- All presented in an intuitive, easy-to-use GUI that allows non-technical, SQL-illiterate users to fully manage databases
53- Allows multiple installations on the same server, each with a different password
54- Secure password-protected interface with login screen and cookies
55
56## Demo
57
58A live demo of phpLiteAdmin can be found here:
59https://demo.phpliteadmin.org/
60
61## Requirements
62
63- a server with PHP >= 5.2.4 installed
64- at least one PHP SQLite library extension installed and enabled: PDO,
65 SQLite3, or SQLiteDatabase
66
67PHP version 5.3.0 and greater usually comes with the SQLite3 extension installed
68and enabled by default so no custom action is necessary.
69
70## Download
71
72The files in the source repositories are meant for development, not for use in production.
73
74You can find the latest downloads here:
75https://www.phpliteadmin.org/download/
76
77## Installation
78
79See https://bitbucket.org/phpliteadmin/public/wiki/Installation
80
81
82## Configuration
83
84**NEW** as of 1.9.4: You can now configure phpLiteAdmin in an external file. If
85you want to do this:
86
87- rename `phpliteadmin.config.sample.php` into `phpliteadmin.config.php`
88- do not change the settings in `phpliteadmin.php` but in
89 `phpliteadmin.config.php`
90
91See https://bitbucket.org/phpliteadmin/public/wiki/Configuration for details.
92
931. Open `phpliteadmin.config.php` (or `phpliteadmin.php` before 1.9.4) in
94 a text editor.
95
962. If you want to have a directory scanned for your databases instead of
97 listing them manually, specify the directory as the value of the
98 `$directory` variable and skip to step 4.
99
1003. If you want to specify your databases manually, set the value of the
101 `$directory` variable as false and modify the `$databases` array to
102 hold the databases you would like to manage.
103
104 - The path field is the file path of the database relative to where
105 `phpliteadmin.php` will be located on the server. For example, if
106 `phpliteadmin.php` is located at "databases/manager/phpliteadmin.php" and
107 you want to manage "databases/yourdatabase.sqlite", the path value
108 would be "../yourdatabase.sqlite".
109
110 - The name field is the human-friendly way of referencing the database
111 within the application. It can be anything you want.
112
1134. Modify the `$password` variable to be the password used for gaining access
114 to the phpLiteAdmin tool.
115
1165. If you want to have multiple installations of phpLiteAdmin on the same
117 server, change the `$cookie_name` variable to be unique for each installation
118 (optional).
119
1206. Save and upload `phpliteadmin.php` to your web server.
121
1227. Open a web browser and navigate to the uploaded `phpliteadmin.php` file. You
123 will be prompted to enter a password. Use the same password you set in step 4.
124
125## Code Repository and pull requests
126
127The code repository is available both on bitbucket and github:
128
129Github: https://github.com/phpLiteAdmin/pla
130
131Bitbucket: https://bitbucket.org/phpliteadmin/public/src
132
133You are welcome to fork the project and send us pull requests on any of these
134platforms.
135
136## Installing a theme
137
1381. Download the themes package from the [project Downloads page](https://www.phpliteadmin.org/download/).
139
1402. Unzip the file and choose your desired theme.
141
1423. Upload `phpliteadmin.css` from the theme's directory alongside
143 `phpliteadmin.php`.
144
1454. Your theme will automatically override the default.
146
147
148## Getting help
149
150The project's wiki provides information on how to do certain things and is
151located at https://bitbucket.org/phpliteadmin/public/wiki/Home .
152In addition, the project's discussion group is located at
153https://groups.google.com/group/phpliteadmin .
154
155
156## Reporting errors and bugs
157
158If you find any issues while using the tool, please report them at
159https://bitbucket.org/phpliteadmin/public/issues?status=new&status=open .
160
161## License
162
163This program is free software: you can redistribute it and/or modify
164it under the terms of the **GNU General Public License** as published by
165the Free Software Foundation, either **version 3** of the License, or
166(at your option) any later version.
167
168This program is distributed in the hope that it will be useful,
169but WITHOUT ANY WARRANTY; without even the implied warranty of
170MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
171GNU General Public License for more details.
172
173You should have received a copy of the GNU General Public License
174along with this program. If not, see <[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)>.
175