random-mirrors/gab-social
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

change all GitHub links to Gab's GitLab at code.gab.com

Browse Source
This commit is contained in:
robcolbert
2019-07-03 13:26:13 -04:00
parent ddae395f91
commit 1ef1a3881d
18 changed files with 101 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/developer.md
View File

@@ -1,12 +1,12 @@
# Gab Social Developer Setup
Developers wanting to work on [Gab Social](https://github.com/gab-ai-inc/gab-social) source code and make changes to the system must configure a host for use with Gab Social's development environment.
Developers wanting to work on [Gab Social](https://code.gab.com/gab/social/gab-social) source code and make changes to the system must configure a host for use with Gab Social's development environment.
The instructions in this file do not create a production-grade host that is secure and can scale. Instead, these instructions deliver a working environment tuned for making changes to Gab Social and for quickly iterating on those changes to get stuff done.
## Host OS
[Gab Social](https://github.com/gab-ai-inc/gab-social) development has been tested on [Ubuntu 18.04LTS](https://www.ubuntu.com/download/desktop). As we continue to migrate further away from Gab Social's code, at least MacOS will be supported as a choice.
[Gab Social](https://code.gab.com/gab/social/gab-social) development has been tested on [Ubuntu 18.04LTS](https://www.ubuntu.com/download/desktop). As we continue to migrate further away from Gab Social's code, at least MacOS will be supported as a choice.
We are unlikely to support Windows as a host OS because no part of our software development infrastructure is based on Windows. We will, however, be happy to review and accept your pull requests adding Windows support for development and even production hosting if you think that's not too nutty.
@@ -28,7 +28,7 @@ sudo apt update
## System Dependencies
The following software components and libraries are required by [Gab Social](https://github.com/gab-ai-inc/gab-social).
The following software components and libraries are required by [Gab Social](https://code.gab.com/gab/social/gab-social).
- *ImageMagick* - Gab Social uses imagemagick for image related operations
- *FFMPEG* - Gab Social uses ffmpeg for conversion of GIFs to MP4s
@@ -58,7 +58,7 @@ apt-get install -y imagemagick ffmpeg libpq-dev libxml2-dev libxslt1-dev file gi
### Install Node.js 10.15.3 LTS
Node.js is required for running the [Gab Social](https://github.com/gab-ai-inc/gab-social) Streaming API server and for other system management tasks related to the Gab Platform.
Node.js is required for running the [Gab Social](https://code.gab.com/gab/social/gab-social) Streaming API server and for other system management tasks related to the Gab Platform.
```bash
# Install nvm to manage Node.js versions
@@ -83,7 +83,7 @@ adduser --disabled-password --quiet gabsocial
## PostgreSQL Database Creation
[Gab Social](https://github.com/gab-ai-inc/gab-social) requires access to a [PostgreSQL](https://www.postgresql.org) instance.
[Gab Social](https://code.gab.com/gab/social/gab-social) requires access to a [PostgreSQL](https://www.postgresql.org) instance.
Create a user for a [PostgreSQL](https://www.postgresql.org) instance:
@@ -127,7 +127,7 @@ git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
```
Now that [`rbenv`](https://github.com/rbenv/rbenv) and [`ruby-build`](https://github.com/rbenv/ruby-build) are installed, we will install the
[Ruby](https://www.ruby-lang.org/en/) version which [Gab Social](https://github.com/gab-ai-inc/gab-social) uses. That version will also need to be enabled.
[Ruby](https://www.ruby-lang.org/en/) version which [Gab Social](https://code.gab.com/gab/social/gab-social) uses. That version will also need to be enabled.
To enable [Ruby](https://www.ruby-lang.org/en/), run:
@@ -140,7 +140,7 @@ This will take some time. Go stretch for a bit and drink some water while the co
### node.js And Ruby Dependencies
Now that [Ruby](https://www.ruby-lang.org/en/) is enabled, we will clone the [Git Social git repository](https://github.com/gab-ai-inc/gab-social) and install the [Ruby](https://www.ruby-lang.org/en/) and [node.js](https://nodejs.org/en/) dependancies.
Now that [Ruby](https://www.ruby-lang.org/en/) is enabled, we will clone the [Git Social git repository](https://code.gab.com/gab/social/gab-social) and install the [Ruby](https://www.ruby-lang.org/en/) and [node.js](https://nodejs.org/en/) dependancies.
Run the following to clone and install:
@@ -150,7 +150,7 @@ mkdir -p ~/projects
cd ~/projects
# Clone the Gab Social repository into ~/projects
git clone https://github.com/gab-ai-inc/gab-social.git gab-social
git clone https://code.gab.com/gab/social/gab-social gab-social
# Hop into the project directory (all are welcome!)
cd ~/projects/gab-social
@@ -211,7 +211,7 @@ You can check code quality with:
## Federation development tips
Federation absolutely requires your Gab Social instance to have a domain name. If you want to operate a permanently-federated development server (Gab does), set up a [Gab Social](https://github.com/gab-ai-inc/gab-social) instance with a domain, and update it against your development fork/branch while doing that development on your local workstation or as a team.
Federation absolutely requires your Gab Social instance to have a domain name. If you want to operate a permanently-federated development server (Gab does), set up a [Gab Social](https://code.gab.com/gab/social/gab-social) instance with a domain, and update it against your development fork/branch while doing that development on your local workstation or as a team.
To test federation on a *local* developer workstation, localhost => world tunneling can be made possible yourself on a domain you manage or by using services like [ngrok](https://ngrok.com).

26
docs/server.md
View File

@@ -10,7 +10,7 @@ This document describes how to prepare a host for development, test, and product
## What is this guide?
This guide is a walk through of the setup process of a [Gab Social](https://github.com/gab-ai-inc/gab-social/) instance.
This guide is a walk through of the setup process of a [Gab Social](https://code.gab.com/gab/social/gab-social) instance.
We use example.com to represent a domain or sub-domain. Example.com should be replaced with your instance domain or sub-domain.
@@ -139,7 +139,7 @@ git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
```
Now that [`rbenv`](https://github.com/rbenv/rbenv) and [`ruby-build`](https://github.com/rbenv/ruby-build) are installed, we will install the
[Ruby](https://www.ruby-lang.org/en/) version which [Gab Social](https://github.com/gab-ai-inc/gab-social) uses. That version will also need to be enabled.
[Ruby](https://www.ruby-lang.org/en/) version which [Gab Social](https://code.gab.com/gab/social/gab-social) uses. That version will also need to be enabled.
To enable [Ruby](https://www.ruby-lang.org/en/), run:
@@ -154,7 +154,7 @@ rbenv global 2.6.1
### node.js And Ruby Dependencies
Now that [Ruby](https://www.ruby-lang.org/en/) is enabled, we will clone the [Gab Social git repository](https://github.com/gab-ai-inc/gab-social/) and install the [Ruby](https://www.ruby-lang.org/en/) and [node.js](https://nodejs.org/en/) dependancies.
Now that [Ruby](https://www.ruby-lang.org/en/) is enabled, we will clone the [Gab Social git repository](https://code.gab.com/gab/social/gab-social) and install the [Ruby](https://www.ruby-lang.org/en/) and [node.js](https://nodejs.org/en/) dependancies.
Run the following to clone and install:
@@ -163,10 +163,10 @@ Run the following to clone and install:
cd ~
# Clone the gabsocial git repository into ~/live
git clone https://github.com/gab-ai-inc/gab-social.git live
git clone https://code.gab.com/gab/social/gab-social live
# Or, clone the developer version (requires credentials)
git clone git@dev.openplatform.us:/opt/git/gab-social live
git clone https://code.gab.com/gab/social/gab-social live
# Change directory to ~/live
cd ~/live
@@ -194,7 +194,7 @@ Eventually, the Ruby On Rails dependencies are going away. This is a stop-gap so
## PostgreSQL Database Creation
[Gab Social](https://github.com/gab-ai-inc/gab-social) requires access to a [PostgreSQL](https://www.postgresql.org) instance.
[Gab Social](https://code.gab.com/gab/social/gab-social) requires access to a [PostgreSQL](https://www.postgresql.org) instance.
Create a user for a [PostgreSQL](https://www.postgresql.org) instance:
@@ -211,7 +211,7 @@ CREATE USER gabsocial CREATEDB;
## nginx Configuration
You need to configure [nginx](http://nginx.org) to serve your [Gab Social](https://github.com/gab-ai-inc/gab-social/) instance.
You need to configure [nginx](http://nginx.org) to serve your [Gab Social](https://code.gab.com/gab/social/gab-social) instance.
**Reminder: Replace all occurrences of example.com with your own instance's domain or sub-domain.**
@@ -407,7 +407,7 @@ For this we will switch to the `gabsocial` system user:
sudo su - gabsocial
```
Change directory to `~/live` and run the [Gab Social](https://github.com/gab-ai-inc/gab-social) setup wizard:
Change directory to `~/live` and run the [Gab Social](https://code.gab.com/gab/social/gab-social) setup wizard:
```sh
cd ~/live
@@ -431,7 +431,7 @@ We will need three [systemd](https://github.com/systemd/systemd) service files f
Now switch back to the root user.
For the [Gab Social](https://github.com/gab-ai-inc/gab-social/) web workers service place the following in `/etc/systemd/system/gabsocial-web.service`:
For the [Gab Social](https://code.gab.com/gab/social/gab-social) web workers service place the following in `/etc/systemd/system/gabsocial-web.service`:
```
[Unit]
@@ -453,7 +453,7 @@ Restart=always
WantedBy=multi-user.target
```
For [Gab Social](https://github.com/gab-ai-inc/gab-social/) background queue service, place the following in `/etc/systemd/system/gabsocial-sidekiq.service`:
For [Gab Social](https://code.gab.com/gab/social/gab-social) background queue service, place the following in `/etc/systemd/system/gabsocial-sidekiq.service`:
```
[Unit]
@@ -474,7 +474,7 @@ Restart=always
WantedBy=multi-user.target
```
For the [Gab Social](https://github.com/gab-ai-inc/gab-social/) streaming API service place the following in `/etc/systemd/system/gabsocial-streaming.service`:
For the [Gab Social](https://code.gab.com/gab/social/gab-social) streaming API service place the following in `/etc/systemd/system/gabsocial-streaming.service`:
```
[Unit]
@@ -550,13 +550,13 @@ SMTP_PASSWORD=HolySnacksAPassword
SMTP_FROM_ADDRESS=Domain.com Gab Social Admin <notifications@gab.com>
```
Finally, to test this, spin up a Rails console (see [the administration guide](https://github.com/gab-ai-inc/gab-social-documentation/blob/master/Running-Gab-Social/Administration-guide.md)) and run the following commands to test this out:
Finally, to test this, spin up a Rails console (see [the administration guide](https://code.gab.com/gab/social/gab-social/blob/master/docs/server.md)) and run the following commands to test this out:
```ruby
m = UserMailer.new.mail to:'email@address.com', subject: 'test', body: 'awoo'
m.deliver
```
That is all! If everything was done correctly, a [Gab Social](https://github.com/gab-ai-inc/gab-social/) instance will appear when you visit `https://example.com` in a web browser.
That is all! If everything was done correctly, a [Gab Social](https://code.gab.com/gab/social/gab-social) instance will appear when you visit `https://example.com` in a web browser.
Congratulations and welcome to Gab Social!