WebSVN – ALCASAR – Diff – /web/acc/phpsysinfo/README.md


phpSysInfo
==============
 
* Copyright (c), 1999-2008, Uriah Welcome ([sf.net/users/precision](https://sf.net/users/precision))
* Copyright (c), 1999-2009, Michael Cramer ([github.com/bigmichi1](https://github.com/bigmichi1), [sf.net/users/bigmichi1](https://sf.net/users/bigmichi1))
* Copyright (c), 2007-2008, Audun Larsen ([sf.net/users/xqus](https://sf.net/users/xqus))
* Copyright (c), 2007-2015, Erkan Valentin ([github.com/rk4an](https://github.com/rk4an), [sf.net/users/jacky672](https://sf.net/users/jacky672))
* Copyright (c), 2009-2023, Mieczyslaw Nalewaj ([github.com/namiltd](https://github.com/namiltd), [sf.net/users/namiltd](https://sf.net/users/namiltd))
* Copyright (c), 2010-2012, Damien Roth ([sf.net/users/iysaak](https://sf.net/users/iysaak))
 
 
REQUIREMENTS
------------
 
PHP 5.1.3 or later with SimpleXML, PCRE, XML and DOM extension.
 
#### Suggested extensions:
- mbstring: Required for *nix non UTF-8 systems
- com_dotnet: Required for Windows environments
- xsl: Required for static mode
- json: Required for bootstrap mode
 
CURRENT TESTED PLATFORMS
------------------------
 
- Linux 2.6+
- FreeBSD 7+
- OpenBSD 2.8+
- NetBSD
- DragonFly
- HP-UX
- Darwin / Mac OS / OS X / iOS
- Windows 2000 / XP / 2003 / Vista / 2008 / 7 / 2011 / 2012 / 8 / 8.1 / 10 / 10 IoT / 2016 / 2019 / 2022 / 11
- Android
 
#### Platforms currently in progress:
- Haiku
- Minix
- SunOS
- ReactOS
- IBM AIX
- QNX
- GNU Hurd
- FortiOS (via SSH)
- DrayOS (via SSH)
 
If your platform is not here try checking out the mailing list archives or
the message boards on Github.
 
INSTALLATION AND CONFIGURATION
------------------------------
 
#### Typical installation
 
Just decompress and untar the source (which you should have done by now,
if you're reading this...), into your webserver's document root.
 
There is a configuration file called phpsysinfo.ini.new. If this a brand new
installation, you should copy this file to phpsysinfo.ini and edit it.
 
- make sure your `php.ini` file's `include_path` entry contains "."
- make sure your `php.ini` has `safe_mode` set to 'off'.
 
phpSysInfo require php-xml extension.
 
Please keep in the mind that because phpSysInfo requires access to many
files in `/proc` and other system binary you **MUST DISABLE** `php's safe_mode`.
Please see the PHP documentation for information on how you
can do this.
 
That's it.  Restart your webserver (if you changed php.ini), and voila.
 
#### Docker container installation
 
- `sudo docker build -t phpsysinfo github.com/phpsysinfo/phpsysinfo#main`
- `sudo docker run -i -p 8080:80 -t phpsysinfo`
- go to http://localhost:8080/phpsysinfo/
 
KNOWN PROBLEMS
--------------
 
- phpSysInfo is not compatible with SELinux Systems
- small bug under FreeBSD with memory reporting
 
PLATFORM SPECIFIC ISSUES
------------------------
 
#### Windows with IIS
  On Windows systems we get our informations through the WMI interface.
  If you run phpSysInfo on the IIS webserver, phpSysInfo will not connect
  to the WMI interface for security reasons. At this point you MUST set
  an authentication mechanism for the directory in the IIS admin
  interface for the directory where phpSysInfo is installed. Then you
  will be asked for an user and a password when opening the page. At this
  point it is necessary to log in with an user that will be able to
  connect to the WMI interface. If you use the wrong user and/or password
  you might get an "ACCESS DENIED ERROR".
 
SENSOR RELATED INFORMATION
---------------------------
 
#### MBM5
  Make sure you set MBM5 Interval Logging to csv and to the data
  directory of phpSysInfo. The file must be called MBM5. Also make sure
  MBM5 doesn't add symbols to the values. This is a Quick MBM5 log parser,
  need more csv logs to make it better.
 
WHAT TO DO IF IT DOESN'T WORK
-----------------------------
 
First make sure you've read this file completely, especially the
"INSTALLATION AND CONFIGURATION" section.  If it still doesn't work then
you can:
 
Ask for help or submit a bug on Github (https://github.com/phpsysinfo/phpsysinfo/issues)
 
***!! If you have any problems, please set `DEBUG` to true in `phpsysinfo.ini`
and include any error messages in your bug report / help request !!***
 
OTHER NOTES
-----------
 
If you have a great idea or want to help out, just create a pull request with your change proposal
in the [phpSysInfo](https://github.com/phpsysinfo/phpsysinfo) repository.
 
LICENSING
---------
 
This program is released under the GNU Public License Version 2 or
(at your option) any later version, see [COPYING](COPYING) for details.
 

Rev 3100	Rev 3179
1	`phpSysInfo`	1	`phpSysInfo`
2	`==============`	2	`==============`
3		3
4	`* Copyright (c), 1999-2008, Uriah Welcome ([sf.net/users/precision](https://sf.net/users/precision))`	4	`* Copyright (c), 1999-2008, Uriah Welcome ([sf.net/users/precision](https://sf.net/users/precision))`
5	`* Copyright (c), 1999-2009, Michael Cramer ([github.com/bigmichi1](https://github.com/bigmichi1), [sf.net/users/bigmichi1](https://sf.net/users/bigmichi1))`	5	`* Copyright (c), 1999-2009, Michael Cramer ([github.com/bigmichi1](https://github.com/bigmichi1), [sf.net/users/bigmichi1](https://sf.net/users/bigmichi1))`
6	`* Copyright (c), 2007-2008, Audun Larsen ([sf.net/users/xqus](https://sf.net/users/xqus))`	6	`* Copyright (c), 2007-2008, Audun Larsen ([sf.net/users/xqus](https://sf.net/users/xqus))`
7	`* Copyright (c), 2007-2015, Erkan Valentin ([github.com/rk4an](https://github.com/rk4an), [sf.net/users/jacky672](https://sf.net/users/jacky672))`	7	`* Copyright (c), 2007-2015, Erkan Valentin ([github.com/rk4an](https://github.com/rk4an), [sf.net/users/jacky672](https://sf.net/users/jacky672))`
8	`* Copyright (c), 2009-2022, Mieczyslaw Nalewaj ([github.com/namiltd](https://github.com/namiltd), [sf.net/users/namiltd](https://sf.net/users/namiltd))`	8	`* Copyright (c), 2009-2023, Mieczyslaw Nalewaj ([github.com/namiltd](https://github.com/namiltd), [sf.net/users/namiltd](https://sf.net/users/namiltd))`
9	`* Copyright (c), 2010-2012, Damien Roth ([sf.net/users/iysaak](https://sf.net/users/iysaak))`	9	`* Copyright (c), 2010-2012, Damien Roth ([sf.net/users/iysaak](https://sf.net/users/iysaak))`
10		10
11		11
12	`REQUIREMENTS`	12	`REQUIREMENTS`
13	`------------`	13	`------------`
14		14
15	`PHP 5.1.3 or later with SimpleXML, PCRE, XML and DOM extension.`	15	`PHP 5.1.3 or later with SimpleXML, PCRE, XML and DOM extension.`
16		16
17	`#### Suggested extensions:`	17	`#### Suggested extensions:`
18	`- mbstring: Required for *nix non UTF-8 systems`	18	`- mbstring: Required for *nix non UTF-8 systems`
19	`- com_dotnet: Required for Windows environments`	19	`- com_dotnet: Required for Windows environments`
20	`- xsl: Required for static mode`	20	`- xsl: Required for static mode`
21	`- json: Required for bootstrap mode`	21	`- json: Required for bootstrap mode`
22		22
23	`CURRENT TESTED PLATFORMS`	23	`CURRENT TESTED PLATFORMS`
24	`------------------------`	24	`------------------------`
25		25
26	`- Linux 2.6+`	26	`- Linux 2.6+`
27	`- FreeBSD 7+`	27	`- FreeBSD 7+`
28	`- OpenBSD 2.8+`	28	`- OpenBSD 2.8+`
29	`- NetBSD`	29	`- NetBSD`
30	`- DragonFly`	30	`- DragonFly`
31	`- HP-UX`	31	`- HP-UX`
32	`- Darwin / Mac OS / OS X / iOS`	32	`- Darwin / Mac OS / OS X / iOS`
33	`- Windows 2000 / XP / 2003 / Vista / 2008 / 7 / 2011 / 2012 / 8 / 8.1 / 10 / 10 IoT / 2016 / 2019 / 2022 / 11`	33	`- Windows 2000 / XP / 2003 / Vista / 2008 / 7 / 2011 / 2012 / 8 / 8.1 / 10 / 10 IoT / 2016 / 2019 / 2022 / 11`
34	`- Android`	34	`- Android`
35		35
36	`#### Platforms currently in progress:`	36	`#### Platforms currently in progress:`
37	`- Haiku`	37	`- Haiku`
38	`- Minix`	38	`- Minix`
39	`- SunOS`	39	`- SunOS`
40	`- ReactOS`	40	`- ReactOS`
41	`- IBM AIX`	41	`- IBM AIX`
42	`- QNX`	42	`- QNX`
43	`- GNU Hurd`	43	`- GNU Hurd`
44	`- FortiOS (via SSH)`	44	`- FortiOS (via SSH)`
45	`- DrayOS (via SSH)`	45	`- DrayOS (via SSH)`
46		46
47	`If your platform is not here try checking out the mailing list archives or`	47	`If your platform is not here try checking out the mailing list archives or`
48	`the message boards on SourceForge.`	48	`the message boards on Github.`
49		49
50	`INSTALLATION AND CONFIGURATION`	50	`INSTALLATION AND CONFIGURATION`
51	`------------------------------`	51	`------------------------------`
52		52
53	`#### Typical installation`	53	`#### Typical installation`
54		54
55	`Just decompress and untar the source (which you should have done by now,`	55	`Just decompress and untar the source (which you should have done by now,`
56	`if you're reading this...), into your webserver's document root.`	56	`if you're reading this...), into your webserver's document root.`
57		57
58	`There is a configuration file called phpsysinfo.ini.new. If this a brand new`	58	`There is a configuration file called phpsysinfo.ini.new. If this a brand new`
59	`installation, you should copy this file to phpsysinfo.ini and edit it.`	59	`installation, you should copy this file to phpsysinfo.ini and edit it.`
60		60
61	- make sure your `php.ini` file's `include_path` entry contains "."	61	- make sure your `php.ini` file's `include_path` entry contains "."
62	- make sure your `php.ini` has `safe_mode` set to 'off'.	62	- make sure your `php.ini` has `safe_mode` set to 'off'.
63		63
64	`phpSysInfo require php-xml extension.`	64	`phpSysInfo require php-xml extension.`
65		65
66	`Please keep in the mind that because phpSysInfo requires access to many`	66	`Please keep in the mind that because phpSysInfo requires access to many`
67	files in `/proc` and other system binary you MUST DISABLE `php's safe_mode`.	67	files in `/proc` and other system binary you MUST DISABLE `php's safe_mode`.
68	`Please see the PHP documentation for information on how you`	68	`Please see the PHP documentation for information on how you`
69	`can do this.`	69	`can do this.`
70		70
71	`That's it. Restart your webserver (if you changed php.ini), and voila.`	71	`That's it. Restart your webserver (if you changed php.ini), and voila.`
72		72
73	`#### Docker container installation`	73	`#### Docker container installation`
74		74
75	- `sudo docker build -t phpsysinfo github.com/phpsysinfo/phpsysinfo#main`	75	- `sudo docker build -t phpsysinfo github.com/phpsysinfo/phpsysinfo#main`
76	- `sudo docker run -i -p 8080:80 -t phpsysinfo`	76	- `sudo docker run -i -p 8080:80 -t phpsysinfo`
77	`- go to http://localhost:8080/phpsysinfo/`	77	`- go to http://localhost:8080/phpsysinfo/`
78		78
79	`KNOWN PROBLEMS`	79	`KNOWN PROBLEMS`
80	`--------------`	80	`--------------`
81		81
82	`- phpSysInfo is not compatible with SELinux Systems`	82	`- phpSysInfo is not compatible with SELinux Systems`
83	`- small bug under FreeBSD with memory reporting`	83	`- small bug under FreeBSD with memory reporting`
84		84
85	`PLATFORM SPECIFIC ISSUES`	85	`PLATFORM SPECIFIC ISSUES`
86	`------------------------`	86	`------------------------`
87		87
88	`#### Windows with IIS`	88	`#### Windows with IIS`
89	`On Windows systems we get our informations through the WMI interface.`	89	`On Windows systems we get our informations through the WMI interface.`
90	`If you run phpSysInfo on the IIS webserver, phpSysInfo will not connect`	90	`If you run phpSysInfo on the IIS webserver, phpSysInfo will not connect`
91	`to the WMI interface for security reasons. At this point you MUST set`	91	`to the WMI interface for security reasons. At this point you MUST set`
92	`an authentication mechanism for the directory in the IIS admin`	92	`an authentication mechanism for the directory in the IIS admin`
93	`interface for the directory where phpSysInfo is installed. Then you`	93	`interface for the directory where phpSysInfo is installed. Then you`
94	`will be asked for an user and a password when opening the page. At this`	94	`will be asked for an user and a password when opening the page. At this`
95	`point it is necessary to log in with an user that will be able to`	95	`point it is necessary to log in with an user that will be able to`
96	`connect to the WMI interface. If you use the wrong user and/or password`	96	`connect to the WMI interface. If you use the wrong user and/or password`
97	`you might get an "ACCESS DENIED ERROR".`	97	`you might get an "ACCESS DENIED ERROR".`
98		98
99	`SENSOR RELATED INFORMATION`	99	`SENSOR RELATED INFORMATION`
100	`---------------------------`	100	`---------------------------`
101		101
102	`#### MBM5`	102	`#### MBM5`
103	`Make sure you set MBM5 Interval Logging to csv and to the data`	103	`Make sure you set MBM5 Interval Logging to csv and to the data`
104	`directory of phpSysInfo. The file must be called MBM5. Also make sure`	104	`directory of phpSysInfo. The file must be called MBM5. Also make sure`
105	`MBM5 doesn't add symbols to the values. This is a Quick MBM5 log parser,`	105	`MBM5 doesn't add symbols to the values. This is a Quick MBM5 log parser,`
106	`need more csv logs to make it better.`	106	`need more csv logs to make it better.`
107		107
108	`WHAT TO DO IF IT DOESN'T WORK`	108	`WHAT TO DO IF IT DOESN'T WORK`
109	`-----------------------------`	109	`-----------------------------`
110		110
111	`First make sure you've read this file completely, especially the`	111	`First make sure you've read this file completely, especially the`
112	`"INSTALLATION AND CONFIGURATION" section. If it still doesn't work then`	112	`"INSTALLATION AND CONFIGURATION" section. If it still doesn't work then`
113	`you can:`	113	`you can:`
114		114
115	`Ask for help or submit a bug on Github (https://github.com/phpsysinfo/phpsysinfo/issues)`	115	`Ask for help or submit a bug on Github (https://github.com/phpsysinfo/phpsysinfo/issues)`
116		116
117	***!! If you have any problems, please set `DEBUG` to true in `phpsysinfo.ini`	117	***!! If you have any problems, please set `DEBUG` to true in `phpsysinfo.ini`
118	`and include any error messages in your bug report / help request !!***`	118	`and include any error messages in your bug report / help request !!***`
119		119
120	`OTHER NOTES`	120	`OTHER NOTES`
121	`-----------`	121	`-----------`
122		122
123	`If you have a great idea or want to help out, just create a pull request with your change proposal`	123	`If you have a great idea or want to help out, just create a pull request with your change proposal`
124	`in the [phpSysInfo](https://github.com/phpsysinfo/phpsysinfo) repository.`	124	`in the [phpSysInfo](https://github.com/phpsysinfo/phpsysinfo) repository.`
125		125
126	`LICENSING`	126	`LICENSING`
127	`---------`	127	`---------`
128		128
129	`This program is released under the GNU Public License Version 2 or`	129	`This program is released under the GNU Public License Version 2 or`
130	`(at your option) any later version, see [COPYING](COPYING) for details.`	130	`(at your option) any later version, see [COPYING](COPYING) for details.`
131		131

Subversion Repositories ALCASAR

(root)/web/acc/phpsysinfo/README.md – Rev 3100 → 3179