Update casing on files, add SUPPORT.md with common solutions. [skip ci]

This commit is contained in:
Buster Silver 2017-07-20 20:33:08 -05:00
parent 0e12a531c7
commit a398d13b36
3 changed files with 71 additions and 0 deletions

71
SUPPORT.md Normal file
View File

@ -0,0 +1,71 @@
# Support for AzuraCast
Having trouble with your AzuraCast installation? These pointers may be able to help.
If you still don't find what you're looking for, check the GitHub Issues section for an existing issue relating to the
one you're experiencing. If one does not exist, create a new one.
## Common Solutions
### Reset an Account Password
If you have lost the password to log into an account, but still have access to the SSH terminal for the server, you can
execute the following command to generate a new random password for an account in the system.
Replace `YOUREMAILADDRESS` with the e-mail address whose password you intend to reset.
##### Docker
```bash
docker-compose run --rm cli azuracast_cli azuracast:account:reset-password YOUREMAILADDRESS
```
##### Traditional
```bash
php /var/azuracast/www/util/cli.php azuracast:account:reset-password YOUREMAILADDRESS
```
### Manually Flush the System Cache
Many parts of the AzuraCast system depend on caches to speed up site performance. Sometimes, these caches can get out of
date, and they may cause errors. You can always flush all site-wide caches using one command-line script:
```bash
docker-compose run --rm cli azuracast_cli cache:clear
```
##### Traditional
```bash
php /var/azuracast/www/util/cli.php cache:clear
```
### Force a Full Update (Traditional Installations)
Normally, the traditional installer's update script only updates the portion of the system that have been modified since
your last update. If an update was interrupted or otherwise is causing trouble, you can force the update script to process
all components, which can often fix any issues:
##### Traditional
```bash
./update.sh --full
```
### Access Files via SFTP (Docker Installations)
By default, SFTP access isn't set up for Docker based installations. If you have a large volume of media files, you may
prefer to upload them via SFTP instead of using the web updater. You should *not* use the host operating system's SFTP,
however, as Docker stores station media inside a Docker-specific volume.
The script below will set up a temporary SFTP server that points to your station media directory inside Docker. The server
will stay running inside the terminal window, so you can easily hit `Ctrl+C` to terminate it when you are finished.
##### Docker
```bash
docker run --rm \
-v azuracast_station_data:/home/azuracast/stations \
-p 2222:22 atmoz/sftp:alpine \
azuracast:azuracast:::stations
```