Rename project and create readme

Author: utarwyn

.docker/Dockerfile

@@ -18,20 +18,20 @@ COPY .docker/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
 RUN rm /etc/nginx/conf.d/default.conf
 
 # Setup document root
-RUN mkdir -p /var/www/html
-RUN chown -R nobody.nobody /var/www/html && \
+RUN mkdir -p /app
+RUN chown -R nobody.nobody /app && \
   chown -R nobody.nobody /run && \
   chown -R nobody.nobody /var/lib/nginx && \
   chown -R nobody.nobody /var/log/nginx
 
 # Create a new volume
-VOLUME /var/www/html/storage
+VOLUME /app/storage
 
 # Switch to a non-root user
 USER nobody
 
 # Add application
-WORKDIR /var/www/html
+WORKDIR /app
 COPY --chown=nobody . ./
 
 # Install Composer dependencies

.docker/nginx.conf

@@ -36,7 +36,7 @@ http {
         listen 8080 default_server;
         server_name _;
 
-        root /var/www/html/public;
+        root /app/public;
         index index.php;
 
         location / {

.github/workflows/publish.yml

@@ -9,7 +9,7 @@ on:
   pull_request:
 
 env:
-  IMAGE_NAME: medias-php-service
+  IMAGE_NAME: files-php-service
 
 jobs:
   test:

README.md

@@ -0,0 +1,53 @@
+<h1 align="center">FilesService</h1>
+
+<h4 align="center">
+A simple service for your web-based files.
+<br>
+Works with PHP 5.6+
+</h4>
+
+<p align="center">
+    <a href="https://github.com/utarwyn/files-php-service/actions?query=workflow%3ABuild"><img src="https://github.com/utarwyn/files-php-service/workflows/Build/badge.svg" alt="Publishing status"></a>
+    <a href="https://github.com/utarwyn/files-php-service/actions?query=workflow%3APublish"><img src="https://github.com/utarwyn/files-php-service/workflows/Publish/badge.svg" alt="Publishing status"></a>
+    <a href="https://packagist.org/packages/utarwyn/files-php-service"><img src="https://poser.pugx.org/utawyn/files-php-service/v/stable.svg" alt="Latest Stable Version"></a>
+    <a href="https://github.com/utarwyn/files-php-service/blob/master/LICENSE"><img src="https://poser.pugx.org/utarwyn/files-php-service/license.svg" alt="License"></a>
+</p>
+
+FilesService is a **lightweight self-hosted service** which provides an easy way to manage web-based files.
+It supplies a documented **RESTful API** and an authentication system based on **OAuth2** to store files in a protected bucket.
+
+Installation
+------------
+
+1. Install the service with Composer:\
+   `composer create-project utarwyn/files-php-service`
+2. Move file `.env.example` to `.env` and configure it.
+3. Use Nginx or Apache to provide an access to the `public` folder.
+
+Use it with Docker
+------------
+
+1. Pull the latest image from [DockerHub][1]:\
+   `docker pull utarwyn/files-php-service`
+2. Create a folder to store uploaded files somewhere.
+3. Create a `.env` file based on the `.env.example` in the repository.
+4. Start the Docker container by providing their paths:\
+   `docker run -v /home/.env:/app/.env -v /home/storage:/app/storage -p 80:8080 utarwyn/files-php-service`
+
+Documentation
+------------
+
+> Soon!
+
+License
+--------
+
+FilesService is open-sourced software licensed under the [MIT license][2].
+
+---
+> GitHub [@utarwyn][3] &nbsp;&middot;&nbsp; Twitter [@Utarwyn][4]
+
+[1]: https://hub.docker.com/r/utarwyn/files-php-service
+[2]: https://opensource.org/licenses/MIT
+[3]: https://github.com/utarwyn
+[4]: https://twitter.com/Utarwyn

app/Auth/AuthController.php

@@ -1,16 +1,16 @@
 <?php
 
-namespace MediasService\Auth;
+namespace FilesService\Auth;
 
-use MediasService\Auth\Token\AuthTokenStrategyFactory;
-use MediasService\Controller;
+use FilesService\Auth\Token\AuthTokenStrategyFactory;
+use FilesService\Controller;
 
 /**
  * Class AuthController.
  *
  * @author  Maxime Malgorn <[email protected]>
  * @license MIT
- * @package MediasService\Auth
+ * @package FilesService\Auth
  * @since   1.0.0
  */
 class AuthController extends Controller

app/Auth/Token/AuthTokenInvalidException.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace MediasService\Auth\Token;
+namespace FilesService\Auth\Token;
 
 use UnexpectedValueException;
 
@@ -10,7 +10,7 @@
  *
  * @author  Maxime Malgorn <[email protected]>
  * @license MIT
- * @package MediasService\Auth\Token
+ * @package FilesService\Auth\Token
  * @since   1.0.0
  */
 class AuthTokenInvalidException extends UnexpectedValueException

app/Auth/Token/AuthTokenStrategy.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace MediasService\Auth\Token;
+namespace FilesService\Auth\Token;
 
 /**
  * Interface AuthTokenStrategy.
  *
  * @author  Maxime Malgorn <[email protected]>
  * @license MIT
- * @package MediasService\Auth\Token
+ * @package FilesService\Auth\Token
  * @since   1.0.0
  */
 interface AuthTokenStrategy

app/Auth/Token/AuthTokenStrategyFactory.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace MediasService\Auth\Token;
+namespace FilesService\Auth\Token;
 
 /**
  * Class AuthTokenStrategyFactory.
  *
  * @author  Maxime Malgorn <[email protected]>
  * @license MIT
- * @package MediasService\Auth\Token
+ * @package FilesService\Auth\Token
  * @since   1.0.0
  */
 class AuthTokenStrategyFactory

app/Auth/Token/JWTAuthTokenStrategy.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace MediasService\Auth\Token;
+namespace FilesService\Auth\Token;
 
 use Firebase\JWT\ExpiredException;
 use Firebase\JWT\JWT;
@@ -11,7 +11,7 @@
  *
  * @author  Maxime Malgorn <[email protected]>
  * @license MIT
- * @package MediasService\Auth\Token
+ * @package FilesService\Auth\Token
  * @since   1.0.0
  */
 class JWTAuthTokenStrategy implements AuthTokenStrategy
@@ -32,7 +32,7 @@ public function __construct()
     public function generate($duration = 3600)
     {
         return JWT::encode([
-            'iss' => 'media_api',
+            'iss' => 'file_api',
             'iat' => time(),
             'exp' => time() + $duration
         ], $this->secret);

app/Controller.php

@@ -1,16 +1,16 @@
 <?php
 
-namespace MediasService;
+namespace FilesService;
 
-use MediasService\Auth\Token\AuthTokenInvalidException;
-use MediasService\Auth\Token\AuthTokenStrategyFactory;
+use FilesService\Auth\Token\AuthTokenInvalidException;
+use FilesService\Auth\Token\AuthTokenStrategyFactory;
 
 /**
  * Main Controller, defines basic behaviors for others controllers.
  *
  * @author  Maxime Malgorn <[email protected]>
  * @license MIT
- * @package MediasService
+ * @package FilesService
  * @since   1.0.0
  */
 class Controller