updates based on installation feedback
This commit is contained in:
		
							parent
							
								
									a79209fbd4
								
							
						
					
					
						commit
						a21345c3c7
					
				
					 3 changed files with 13 additions and 6 deletions
				
			
		
							
								
								
									
										15
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										15
									
								
								README.md
									
										
									
									
									
								
							| 
						 | 
					@ -2,6 +2,7 @@
 | 
				
			||||||
NOTE: this is work in progress, it is nowhere near completion nor function
 | 
					NOTE: this is work in progress, it is nowhere near completion nor function
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## installation
 | 
					## installation
 | 
				
			||||||
 | 
					install composer via your package manager or via the official documation
 | 
				
			||||||
install dependencies by using
 | 
					install dependencies by using
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> composer install
 | 
					> composer install
 | 
				
			||||||
| 
						 | 
					@ -27,18 +28,22 @@ Needed SQL commands:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
After this, change the settings in the ini file to match above changed passwords.
 | 
					After this, change the settings in the ini file to match above changed passwords.
 | 
				
			||||||
change to php/federator and run
 | 
					change to php/federator and run
 | 
				
			||||||
    php maintenance dbupgrade
 | 
					    php maintenance.php dbupgrade
 | 
				
			||||||
to install all the needed table. Also run this after an update.
 | 
					to install all the needed table. Also run this after an update.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
If the include redis cache is enabled, create a users.acl for redis with the content:
 | 
					If the include redis cache is enabled,
 | 
				
			||||||
 | 
					- install redis
 | 
				
			||||||
 | 
					- create a users.acl for redis with the content:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    user federator on ~u_* +get +set  ~s_* +get +setex ~m_* +get +setex >redis*change*password
 | 
					    user federator on ~u_* +get +set  ~s_* +get +setex ~m_* +get +setex >redis*change*password
 | 
				
			||||||
 | 
					
 | 
				
			||||||
change password in the rediscache.ini to match your given password.
 | 
					- change password in the rediscache.ini to match your given password.
 | 
				
			||||||
 | 
					- install the redis plugin from pecl if not provided via your distro
 | 
				
			||||||
 | 
					- enable openssl in php.ini if not already done
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To configure an apache server, add the following rewrite rules:
 | 
					To configure an apache server, add the following rewrite rules:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    <Directory /where/ever/you/put/it>
 | 
					    <Directory /where/ever/you/put/it/htdocs>
 | 
				
			||||||
      RewriteEngine on
 | 
					      RewriteEngine on
 | 
				
			||||||
      RewriteBase /
 | 
					      RewriteBase /
 | 
				
			||||||
      RewriteCond expr "%{HTTP:accept} -strcmatch '*application/ld+json*'" [OR]
 | 
					      RewriteCond expr "%{HTTP:accept} -strcmatch '*application/ld+json*'" [OR]
 | 
				
			||||||
| 
						 | 
					@ -52,6 +57,8 @@ To configure an apache server, add the following rewrite rules:
 | 
				
			||||||
      RewriteRule ^(nodeinfo/2\.[01])$ /federator.php?_call=$1 [L,END]
 | 
					      RewriteRule ^(nodeinfo/2\.[01])$ /federator.php?_call=$1 [L,END]
 | 
				
			||||||
    </Directory>
 | 
					    </Directory>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					change your document root for the domain you want to use (or default one if using localhost) to the directory you installed it, with the /htdocs at the end. A user should only be able to open that file, not the other data.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
With the dummy plugin and everything installed correctly a
 | 
					With the dummy plugin and everything installed correctly a
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> curl -v http://localhost/api/federator/v1/dummy/moo -H "X-Session: somethingvalid" -H "X-Profile: ihaveone"
 | 
					> curl -v http://localhost/api/federator/v1/dummy/moo -H "X-Session: somethingvalid" -H "X-Profile: ihaveone"
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,2 +1,2 @@
 | 
				
			||||||
alter table users add `validuntil` timestamp default 0;
 | 
					alter table users add `validuntil` timestamp null default null;
 | 
				
			||||||
update settings set `value`="2024-07-21" where `key`="database_version";
 | 
					update settings set `value`="2024-07-21" where `key`="database_version";
 | 
				
			||||||
| 
						 | 
					@ -1,7 +1,7 @@
 | 
				
			||||||
alter table users add `type` enum('person', 'group') default 'person';
 | 
					alter table users add `type` enum('person', 'group') default 'person';
 | 
				
			||||||
alter table users add `name` varchar(255) default '';
 | 
					alter table users add `name` varchar(255) default '';
 | 
				
			||||||
alter table users add `summary` text default '';
 | 
					alter table users add `summary` text default '';
 | 
				
			||||||
alter table users add `registered` timestamp default 0;
 | 
					alter table users add `registered` timestamp null default null;
 | 
				
			||||||
alter table users add `iconmediatype` varchar(255) default '';
 | 
					alter table users add `iconmediatype` varchar(255) default '';
 | 
				
			||||||
alter table users add `iconurl` varchar(255) default '';
 | 
					alter table users add `iconurl` varchar(255) default '';
 | 
				
			||||||
alter table users add `imagemediatype` varchar(255) default '';
 | 
					alter table users add `imagemediatype` varchar(255) default '';
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		
		Reference in a new issue