README.md 3.02 KB
Newer Older
1
# Poduptime
2

dmorley's avatar
dmorley committed
3
Poduptime is software to get live stats and data on listed Diaspora and other Pods that support nodeinfo output.
4

dmorley's avatar
dmorley committed
5 6 7 8 9
# To Install:

Environmental items you need (debian based system assumed):

OS Dependencies:
10
```
11
php7.2 php7.2-curl php7.2-pgsql php7.2-bcmath php-geoip php7.2-cli php7.2-common php7.2-fpm php7.2-bcmath php7.2-json php7.2-readline php7.2-mbstring php7.2-xml php-cgi git curl postgresql postgresql-contrib dnsutils bind9 npm nodejs composer
12
```
dmorley's avatar
dmorley committed
13 14 15

Yarn is a separate install: https://yarnpkg.com

16

dmorley's avatar
dmorley committed
17
Clone and setup:
18
```
dmorley's avatar
dmorley committed
19
git clone https://git.feneas.org/diasporg/Poduptime
20
cd Poduptime
dmorley's avatar
dmorley committed
21
yarn install
David Morley's avatar
David Morley committed
22
composer install
dmorley's avatar
dmorley committed
23
cp config.php.example config.php (all fields required)
24
```
25

26 27 28 29 30 31 32 33 34 35 36
If you need to setup your Postgresql/DB:
```
sudo adduser podupuser
sudo -u postgres bash -c "psql -c \"CREATE USER podupuser WITH PASSWORD 'MYpassword';\""
sudo -u postgres bash -c "psql -c \"CREATE DATABASE podupdb;\""
sudo -u postgres bash -c "psql -c \"GRANT ALL PRIVILEGES ON DATABASE podupdb TO podupuser;\""

# update your local line to allow md5 METHOD
sudo nano /etc/postgresql/vx.x/main/pg_hba.conf

# restart postgresql
dmorley's avatar
dmorley committed
37
```
38

dmorley's avatar
dmorley committed
39 40
Import database schema
```
dmorley's avatar
dmorley committed
41
psql -U podupuser podupdb < db/tables.sql
42 43
```

44 45 46 47 48
Configure your webserver (nginx example)
```
see file http-server-config.example
```

dmorley's avatar
dmorley committed
49
1. Edit `config.php` to add your DB and file settings
50 51
2. Create your backup folder
3. Add a pod and run `php db/update.php init` 
dmorley's avatar
dmorley committed
52 53

# To Use:
54

dmorley's avatar
dmorley committed
55 56 57 58 59
run `php db/update.php` to update your data  
run `php db/update.php debug` to debug output  
run `php db/update.php sqldebug` to debug sql  
run `php db/update.php develop` to run without email alerts to end users  
run `php db/update.php Check_System_Deleted` to re-check system deleted pods as needed  
dmorley's avatar
dmorley committed
60
These commands can be combined  
61

dmorley's avatar
dmorley committed
62
# To Upgrade:
63 64
```
git pull
dmorley's avatar
dmorley committed
65
yarn install
David Morley's avatar
David Morley committed
66
composer install
dmorley's avatar
dmorley committed
67
psql -U podupuser podupdb < db/migrations/xxx.sql (see db/migrations/README.md for proper migration versions)
68 69
```

dmorley's avatar
dmorley committed
70
# Status
dmorley's avatar
dmorley committed
71

dmorley's avatar
dmorley committed
72 73
[![pipeline status](https://git.feneas.org/diasporg/Poduptime/badges/develop/pipeline.svg)](https://git.feneas.org/diasporg/Poduptime/commits/develop)
[![coverage report](https://git.feneas.org/diasporg/Poduptime/badges/develop/coverage.svg)](https://git.feneas.org/diasporg/Poduptime/commits/develop)
dmorley's avatar
dmorley committed
74 75


krishna's avatar
krishna committed
76 77
============================

dmorley's avatar
dmorley committed
78
Source for Diaspora Pod Uptime
David Morley's avatar
1st  
David Morley committed
79

krishna's avatar
krishna committed
80 81
  Poduptime is software to get live stats and data on listed Diaspora Pods.
  Copyright (C) 2011 David Morley
82

krishna's avatar
krishna committed
83 84 85 86
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as
  published by the Free Software Foundation, either version 3 of the
  License, or (at your option) any later version.
87

krishna's avatar
krishna committed
88 89 90 91
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Affero General Public License for more details.
92

krishna's avatar
krishna committed
93
  You should have received a copy of the GNU Affero General Public License
94
  along with this program.  If not, see <https://www.gnu.org/licenses/>.