Added new Docker based readme, prepped config file for Docker use.
Brock Freeman
9 years ago
parent
2dfcc93585
commit
d6eb971092
@ -0,0 +1,143 @@
|
||||
# phpLiteAdmin
|
||||
|
||||
## What is phpLiteAdmin?
|
||||
|
||||
phpLiteAdmin is a web-based SQLite database admin tool written in PHP with
|
||||
support for SQLite3 and SQLite2. Following in the spirit of the flat-file system
|
||||
used by SQLite, phpLiteAdmin consists of a single source file, phpliteadmin.php,
|
||||
that is dropped into a directory on a server and then visited in a browser.
|
||||
There is no installation required. The available operations, feature set,
|
||||
interface, and user experience is comparable to that of phpMyAdmin.
|
||||
|
||||
## Features
|
||||
|
||||
- Lightweight - consists of a single 200KB source file for portability
|
||||
- Supports SQLite3 and SQLite2 databases
|
||||
- Translated and available in over 10 languages - and counting
|
||||
- Specify and manage an unlimited number of databases
|
||||
- Specify a directory and optionally its subdirectories to scan for databases
|
||||
- Create and delete databases
|
||||
- Add, delete, rename, empty, and drop tables
|
||||
- Browse, add, edit, and delete records
|
||||
- Add, delete, and edit table columns
|
||||
- Manage table indexes
|
||||
- Manage table triggers
|
||||
- Import and export tables, structure, indexes, and data (SQL, CSV)
|
||||
- View data as bar, pie, and line charts
|
||||
- Graphical search tool to find records based on specified field values
|
||||
- Create and run your own custom SQL queries in the free-form query editor/builder
|
||||
- Easily apply core SQLite functions to column values using the GUI
|
||||
- Write your own PHP functions to be available to apply to column values
|
||||
- Design your own theme using CSS or install a pre-made theme from the community
|
||||
- All presented in an intuitive, easy-to-use GUI that allows non-technical, SQL-illiterate users to fully manage databases
|
||||
- Allows multiple installations on the same server, each with a different password
|
||||
- Secure password-protected interface with login screen and cookies
|
||||
|
||||
## Demo
|
||||
|
||||
A live demo of phpLiteAdmin can be found here:
|
||||
http://demo.phpliteadmin.christosoft.de/
|
||||
|
||||
## Requirements
|
||||
|
||||
- a server with PHP >= 5.2.0 installed
|
||||
- at least one PHP SQLite library extension installed and enabled: PDO,
|
||||
SQLite3, or SQLiteDatabase
|
||||
|
||||
PHP version 5.3.0 and greater usually comes with the SQLite3 extension installed
|
||||
and enabled by default so no custom action is necessary.
|
||||
|
||||
## Download
|
||||
|
||||
The files in the source repositories are for development.
|
||||
|
||||
You can find the latest stable single-file version here:
|
||||
https://bitbucket.org/phpliteadmin/public/wiki/DownloadLinks
|
||||
|
||||
The latest single-file version of the development version can be found here:
|
||||
https://phpliteadmin.christosoft.de/phpliteadmin.zip
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
See https://bitbucket.org/phpliteadmin/public/wiki/Installation
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
**NEW** as of 1.9.4: You can now configure phpLiteAdmin in an external file. If
|
||||
you want to do this:
|
||||
|
||||
- rename `phpliteadmin.config.sample.php` into `phpliteadmin.config.php`
|
||||
- do not change the settings in `phpliteadmin.php` but in
|
||||
`phpliteadmin.config.php`
|
||||
|
||||
See https://bitbucket.org/phpliteadmin/public/wiki/Configuration for details.
|
||||
|
||||
1. Open `phpliteadmin.config.php` (or `phpliteadmin.php` before 1.9.4) in
|
||||
a text editor.
|
||||
|
||||
2. If you want to have a directory scanned for your databases instead of
|
||||
listing them manually, specify the directory as the value of the
|
||||
`$directory` variable and skip to step 4.
|
||||
|
||||
3. If you want to specify your databases manually, set the value of the
|
||||
`$directory` variable as false and modify the `$databases` array to
|
||||
hold the databases you would like to manage.
|
||||
|
||||
- The path field is the file path of the database relative to where
|
||||
`phpliteadmin.php` will be located on the server. For example, if
|
||||
`phpliteadmin.php` is located at "databases/manager/phpliteadmin.php" and
|
||||
you want to manage "databases/yourdatabase.sqlite", the path value
|
||||
would be "../yourdatabase.sqlite".
|
||||
|
||||
- The name field is the human-friendly way of referencing the database
|
||||
within the application. It can be anything you want.
|
||||
|
||||
4. Modify the `$password` variable to be the password used for gaining access
|
||||
to the phpLiteAdmin tool.
|
||||
|
||||
5. If you want to have multiple installations of phpLiteAdmin on the same
|
||||
server, change the `$cookie_name` variable to be unique for each installation
|
||||
(optional).
|
||||
|
||||
6. Save and upload `phpliteadmin.php` to your web server.
|
||||
|
||||
7. Open a web browser and navigate to the uploaded `phpliteadmin.php` file. You
|
||||
will be prompted to enter a password. Use the same password you set in step 4.
|
||||
|
||||
## Code Repository and pull requests
|
||||
|
||||
The code repository is available both on bitbucket and github:
|
||||
|
||||
Github: https://github.com/phpLiteAdmin/pla
|
||||
|
||||
Bitbucket: https://bitbucket.org/phpliteadmin/public/src
|
||||
|
||||
You are welcome to fork the project and send us pull requests on any of these
|
||||
platforms.
|
||||
|
||||
## Installing a theme
|
||||
|
||||
1. Download the themes package from the project Downloads page.
|
||||
|
||||
2. Unzip the file and choose your desired theme.
|
||||
|
||||
3. Upload `phpliteadmin.css` from the theme's directory alongside
|
||||
`phpliteadmin.php`.
|
||||
|
||||
4. Your theme will automatically override the default.
|
||||
|
||||
|
||||
## Getting help
|
||||
|
||||
The project's wiki provides information on how to do certain things and is
|
||||
located at https://bitbucket.org/phpliteadmin/public/wiki/Home .
|
||||
In addition, the project's discussion group is located at
|
||||
http://groups.google.com/group/phpliteadmin .
|
||||
|
||||
|
||||
## Reporting errors and bugs
|
||||
|
||||
If you find any issues while using the tool, please report them at
|
||||
https://bitbucket.org/phpliteadmin/public/issues?status=new&status=open .
|
||||
@ -1,143 +1,30 @@
|
||||
# phpLiteAdmin
|
||||
|
||||
## What is phpLiteAdmin?
|
||||
|
||||
phpLiteAdmin is a web-based SQLite database admin tool written in PHP with
|
||||
support for SQLite3 and SQLite2. Following in the spirit of the flat-file system
|
||||
used by SQLite, phpLiteAdmin consists of a single source file, phpliteadmin.php,
|
||||
that is dropped into a directory on a server and then visited in a browser.
|
||||
There is no installation required. The available operations, feature set,
|
||||
interface, and user experience is comparable to that of phpMyAdmin.
|
||||
|
||||
## Features
|
||||
|
||||
- Lightweight - consists of a single 200KB source file for portability
|
||||
- Supports SQLite3 and SQLite2 databases
|
||||
- Translated and available in over 10 languages - and counting
|
||||
- Specify and manage an unlimited number of databases
|
||||
- Specify a directory and optionally its subdirectories to scan for databases
|
||||
- Create and delete databases
|
||||
- Add, delete, rename, empty, and drop tables
|
||||
- Browse, add, edit, and delete records
|
||||
- Add, delete, and edit table columns
|
||||
- Manage table indexes
|
||||
- Manage table triggers
|
||||
- Import and export tables, structure, indexes, and data (SQL, CSV)
|
||||
- View data as bar, pie, and line charts
|
||||
- Graphical search tool to find records based on specified field values
|
||||
- Create and run your own custom SQL queries in the free-form query editor/builder
|
||||
- Easily apply core SQLite functions to column values using the GUI
|
||||
- Write your own PHP functions to be available to apply to column values
|
||||
- Design your own theme using CSS or install a pre-made theme from the community
|
||||
- All presented in an intuitive, easy-to-use GUI that allows non-technical, SQL-illiterate users to fully manage databases
|
||||
- Allows multiple installations on the same server, each with a different password
|
||||
- Secure password-protected interface with login screen and cookies
|
||||
|
||||
## Demo
|
||||
|
||||
A live demo of phpLiteAdmin can be found here:
|
||||
http://demo.phpliteadmin.christosoft.de/
|
||||
|
||||
## Requirements
|
||||
|
||||
- a server with PHP >= 5.2.0 installed
|
||||
- at least one PHP SQLite library extension installed and enabled: PDO,
|
||||
SQLite3, or SQLiteDatabase
|
||||
|
||||
PHP version 5.3.0 and greater usually comes with the SQLite3 extension installed
|
||||
and enabled by default so no custom action is necessary.
|
||||
|
||||
## Download
|
||||
|
||||
The files in the source repositories are for development.
|
||||
|
||||
You can find the latest stable single-file version here:
|
||||
https://bitbucket.org/phpliteadmin/public/wiki/DownloadLinks
|
||||
|
||||
The latest single-file version of the development version can be found here:
|
||||
https://phpliteadmin.christosoft.de/phpliteadmin.zip
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
See https://bitbucket.org/phpliteadmin/public/wiki/Installation
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
**NEW** as of 1.9.4: You can now configure phpLiteAdmin in an external file. If
|
||||
you want to do this:
|
||||
|
||||
- rename `phpliteadmin.config.sample.php` into `phpliteadmin.config.php`
|
||||
- do not change the settings in `phpliteadmin.php` but in
|
||||
`phpliteadmin.config.php`
|
||||
|
||||
See https://bitbucket.org/phpliteadmin/public/wiki/Configuration for details.
|
||||
|
||||
1. Open `phpliteadmin.config.php` (or `phpliteadmin.php` before 1.9.4) in
|
||||
a text editor.
|
||||
|
||||
2. If you want to have a directory scanned for your databases instead of
|
||||
listing them manually, specify the directory as the value of the
|
||||
`$directory` variable and skip to step 4.
|
||||
|
||||
3. If you want to specify your databases manually, set the value of the
|
||||
`$directory` variable as false and modify the `$databases` array to
|
||||
hold the databases you would like to manage.
|
||||
|
||||
- The path field is the file path of the database relative to where
|
||||
`phpliteadmin.php` will be located on the server. For example, if
|
||||
`phpliteadmin.php` is located at "databases/manager/phpliteadmin.php" and
|
||||
you want to manage "databases/yourdatabase.sqlite", the path value
|
||||
would be "../yourdatabase.sqlite".
|
||||
|
||||
- The name field is the human-friendly way of referencing the database
|
||||
within the application. It can be anything you want.
|
||||
|
||||
4. Modify the `$password` variable to be the password used for gaining access
|
||||
to the phpLiteAdmin tool.
|
||||
|
||||
5. If you want to have multiple installations of phpLiteAdmin on the same
|
||||
server, change the `$cookie_name` variable to be unique for each installation
|
||||
(optional).
|
||||
|
||||
6. Save and upload `phpliteadmin.php` to your web server.
|
||||
|
||||
7. Open a web browser and navigate to the uploaded `phpliteadmin.php` file. You
|
||||
will be prompted to enter a password. Use the same password you set in step 4.
|
||||
|
||||
## Code Repository and pull requests
|
||||
|
||||
The code repository is available both on bitbucket and github:
|
||||
|
||||
Github: https://github.com/phpLiteAdmin/pla
|
||||
|
||||
Bitbucket: https://bitbucket.org/phpliteadmin/public/src
|
||||
|
||||
You are welcome to fork the project and send us pull requests on any of these
|
||||
platforms.
|
||||
|
||||
## Installing a theme
|
||||
|
||||
1. Download the themes package from the project Downloads page.
|
||||
|
||||
2. Unzip the file and choose your desired theme.
|
||||
|
||||
3. Upload `phpliteadmin.css` from the theme's directory alongside
|
||||
`phpliteadmin.php`.
|
||||
|
||||
4. Your theme will automatically override the default.
|
||||
|
||||
|
||||
## Getting help
|
||||
|
||||
The project's wiki provides information on how to do certain things and is
|
||||
located at https://bitbucket.org/phpliteadmin/public/wiki/Home .
|
||||
In addition, the project's discussion group is located at
|
||||
http://groups.google.com/group/phpliteadmin .
|
||||
|
||||
|
||||
## Reporting errors and bugs
|
||||
|
||||
If you find any issues while using the tool, please report them at
|
||||
https://bitbucket.org/phpliteadmin/public/issues?status=new&status=open .
|
||||
# Dockerized phpLiteAdmin
|
||||
This is a Dockerized flavor of phpLiteAdmin 1.9.6.
|
||||
|
||||
## What is phpLiteAdmin?
|
||||
phpLiteAdmin is a web-based SQLite database admin tool written in PHP with support for SQLite3 and SQLite2. Following in the spirit of the flat-file system used by SQLite, phpLiteAdmin consists of a single source file, `phpliteadmin.php`, that after being deployed with the Docker container, is visited in a browser.
|
||||
|
||||
For more details see the [phpLiteAdmin README](phpLiteAdmin_README.md).
|
||||
|
||||
### phpLiteAdmin Links
|
||||
* Website: http://www.phpliteadmin.org/
|
||||
* Bitbucket: https://bitbucket.org/phpliteadmin/public/
|
||||
* Demo - A live demo of phpLiteAdmin can be found here: http://demo.phpliteadmin.org/
|
||||
|
||||
## Setup
|
||||
1. Open `phpliteadmin.config.php` in a text editor.
|
||||
2. Modify the `$password` variable to be the password you want for gaining access to the phpLiteAdmin tool.
|
||||
3. Build the image `$ docker build -t acttaiwan/phpliteadmin .`
|
||||
|
||||
Additional Configuration Options can be found in the [phpLiteAdmin README](phpLiteAdmin_README.md).
|
||||
|
||||
## Run
|
||||
Replace the `/path/to/db/directory` below with the actual path where your db is.
|
||||
`$ docker run -it --rm -p 2015:2015 -v /path/to/db/directory:/db --name websql acttaiwan/phpliteadmin`
|
||||
|
||||
`$ docker run -it --rm -p 2015:2015 -v $(pwd):/db --name websql acttaiwan/phpliteadmin`
|
||||
|
||||
Access the admin page at http://localhost:2015/phpliteadmin.php
|
||||
|
||||
## Let's Encrypt Auto SSL
|
||||
See the Docker hub [abiosoft/caddy](https://hub.docker.com/r/abiosoft/caddy/) page.
|
||||
Loading…
Reference in New Issue