ceph/man/radosgw.8
2011-08-10 13:43:02 -07:00

75 lines
2.3 KiB
Groff

.TH RADOSGW 8
.SH NAME
radosgw \- rados REST gateway
.SH SYNOPSIS
.B radosgw
.SH DESCRIPTION
.B radosgw
is an HTTP REST gateway for the RADOS object store, a part of the Ceph
distributed storage system. It is implemented as a FastCGI module using
libfcgi, and can be used in conjunction with any FastCGI capable web server.
.SH OPTIONS
.TP
\fB\-c\fI ceph.conf\fR, \fB\-\-conf=\fIceph.conf\fR
Use \fIceph.conf\fP configuration file instead of the default \fI/etc/ceph/ceph.conf\fP
to determine monitor addresses during startup.
.TP
\fB\-m\fI monaddress[:port]\fR
Connect to specified monitor (instead of looking through \fIceph.conf\fR).
.TP
\fB\-\-rgw\-socket\-path=\fIpath\fR
Specify a unix domain socket path.
.SH EXAMPLES
An apache example configuration for using the RADOS gateway:
.IP
<VirtualHost *:80>
ServerName rgw.example1.com
ServerAlias rgw
ServerAdmin webmaster@example1.com
DocumentRoot /var/www/web1/web/
#turn engine on
RewriteEngine On
#following is important for RGW/rados
RewriteRule ^/([a-zA-Z0-9\-\_\.]*)([/]?.*) /s3gw.fcgi?page=$1&params=$2&%{QUERY_STRING} [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
<IfModule mod_fcgid.c>
SuexecUserGroup web1 web1
<Directory /var/www/web1/web/>
Options +ExecCGI
AllowOverride All
SetHandler fcgid-script
FCGIWrapper /var/www/fcgi-scripts/web1/radosgw .fcgi
Order allow,deny
Allow from all
AuthBasicAuthoritative Off
</Directory>
</IfModule>
AllowEncodedSlashes On
# ErrorLog /var/log/apache2/error.log
# CustomLog /var/log/apache2/access.log combined
ServerSignature Off
</VirtualHost>
.PP
And the corresponding radosgw script:
.IP
#!/bin/sh
/usr/bin/radosgw -c /etc/ceph.conf
.PP
By default radosgw will run as single threaded and its execution will be controlled by the fastcgi process manager.
An alternative way to run it would be by specifying (along the lines of) the following in the apache config:
.IP
FastCgiExternalServer /var/www/web1/web/s3gw.fcgi -socket /tmp/.radosgw.sock
.PP
and specify a unix domain socket path (either by passing a command line option, or through ceph.conf).
.SH AVAILABILITY
.B radosgw
is part of the Ceph distributed file system. Please refer to the Ceph wiki at
http://ceph.newdream.net/wiki for more information.
.SH SEE ALSO
.BR ceph (8)